@mainframe/rpc-stream
v0.3.0
Published
Stream-based RPC
Downloads
21
Keywords
Readme
rpc-stream
Class extending rpc-base
to handle stateful JSON-RPC 2.0 calls.
See transport-ipc
, transport-ws-browser
and transport-ws-node
for possible transports and rpc-request
to handle stateless JSON-RPC 2.0 calls.
Installation
yarn add @mainframe/rpc-stream
Usage
import StreamRPC from '@mainframe/rpc-stream'
import ipcTransport from '@mainframe/transport-ipc'
class MyAPI extends StreamRPC {
constructor(path: string) {
super(ipcTransport(path))
}
getUser(id: string): Promise<{ name: string }> {
return this.request('getUser', [id])
}
}
const api = new MyAPI('/path/to/socket')
api.getUser('1234')
API
See the BaseRPC
API for inherited methods and properties.
new StreamRPC()
Arguments
subject: Subject
: a RxJSSubject
handling communication with the server.
.request()
Arguments
method: string
params: T = any
Returns Promise<R = any>
License
MIT