IPC for Pear
npm install pear-ipc
const IPC = require('pear-ipc')
import IPC from 'pear-ipc'
Options
socketPath
<String>
- Path to Unix socket / Windows pipe fileconnectTimeout
<Number[ms]>
- Fail after given milliseconds if unable to connectconnect
<Boolean>|<Function>
- If truthy, attempt to connect. If a function, pear-ipc calls it to boot sidecar.methods
<Array... { id: <Number[int]>, name: <String>, stream: <Boolean(false)>, send: <Boolean(false)> }>
- an index of method descriptions. The order of methods (and their settings) must be consistent across all RPC instances using the same method set. The index of a method in the array is that methods uint identifier.['myMethod']
and[{name: 'myMethod'}]
are equivalent. Generated methods default to being request-based (stream:false
andsend:false
). Settingsend: true
will generate a fire-and-forget method. Settingstream: true
will generate a method that returns a [Streamx][https://github.com/mafintosh/streamx] stream response. For more complex cases, theapi
option can be used to wrap define the instance method.api
{ [name]: (method) => (params) => <Stream|Promise|Any> }
- Define outgoing methods on the RPC instance. Property names on theapi
object matching names in themethods
array will be used to generate instance methods if provided. A tiny-buffer-rpcmethod
object will be passed. Call any/all ofmethod.request
method.send
ormethod.createRequestStream
and make any other calls or alterations as needed.handlers
-{ [name]: (params) => <Stream|Promise|Any> }
- Handle incoming calls. Property names on thehandlers
object matching names in themethods
array passed the incomingparams
object. It is up to the handler to return the correct response for that method.stream
<Duplex>
- Advanced. Set a custom transport stream
Apache-2.0