# rpcjs > Promise-based RPC. Works in browser, node, electron, you name it. Any transport you like. Latest version **1.1.0** (published 2016-03-10) · MIT license · 0 weekly downloads ## Install ```sh npm install rpcjs pnpm add rpcjs yarn add rpcjs bun add rpcjs ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.1.0 | | Published | 2016-03-10 | | First published | 2016-03-10 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >= 0.10.0 | | Dependencies | 4 | | Known vulnerabilities | 0 (+6 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 1 | | Author | Tim Ruffles | | Maintainers | timruffles | | Keywords | promise, rpc, async | ## Links - npm: https://www.npmjs.com/package/rpcjs - Repository: https://github.com/sidekickcode/rpcjs - Homepage: https://github.com/sidekickcode/rpcjs#readme - Issues: https://github.com/sidekickcode/rpcjs/issues - npm.io page: https://npm.io/package/rpcjs ## Dependencies (4) - [debug](https://npm.io/package/debug.md) ^2.2.0 - [lodash](https://npm.io/package/lodash.md) ^3.10.1 - [bluebird](https://npm.io/package/bluebird.md) ^3.3.4 - [universal-promise-helpers](https://npm.io/package/universal-promise-helpers.md) ^1.0.1 ## Alternatives - [@commercetools/sync-actions](https://npm.io/package/@commercetools/sync-actions.md) — 25.1K weekly downloads - [cwait](https://npm.io/package/cwait.md) — 21.4K weekly downloads - [@ledgerhq/hw-app-cosmos](https://npm.io/package/@ledgerhq/hw-app-cosmos.md) — 4.2K weekly downloads - [@financial-times/o-loading](https://npm.io/package/@financial-times/o-loading.md) — 2.8K weekly downloads - [fa](https://npm.io/package/fa.md) — 185 weekly downloads ## Recent versions - 1.1.0 (latest) — 2016-03-10 - 1.0.4 — 2016-03-10 - 1.0.2 — 2016-03-10 - 1.0.1 — 2016-03-10 ## README # RPCjs [![Build Status](https://travis-ci.org/sidekickcode/rpcjs.svg?branch=master)](https://travis-ci.org/sidekickcode/rpcjs) The easiest RPC you've seen, entirely promise based, that plays well with: - all environments: Node, Browser, Electron etc - all transports: TPC, sockets, whatever you fancy? - all Promise-A implemenations: Bluebird, Q, ES6, jQuery etc - all node versions: 0.10 +, es6 or not RPC nodes are the core of the API. The transport is defined by you, so you can do whatever you like. There are built-in transports. A design goal is to let client code be as uncluttered by RPC stuff as possible (e.g calling a method without worrying about having to connect first), while giving control to handle timeouts etc that're vital with RPC. All methods return a promise. they will timeout if the remote end never turns up. Documentation below uses TypeScript as it's a nicely defined way of talking about types! ## `rpcjs.rpc(option: RpcOptions) => RpcPair` interface RpcOptions { name: string Promise: PromiseConstructor timeout: number emitTimeout: number error: (err) => void wrapEffects: () => void } interface RpcTransport { send: () => void } returns a new RpcPair ## methods of `RpcPair` instance ### `expose(name: string, (...args: Array) => Promise | any) => void` ### `expose({[name: string]: (...args: Array) => Promise | any)}) => void` expose either a single or an object of methods to remote side. methods can be sync or async; always async for remote side node.expose("answer", function(number) { return number + 42; }); ### `call(options: { timeout: number}, method, ...args: Array) => Promise` ### `call(method : string, ...args: Array) => Promise` Takes call options as optional first argument (useful for `.bind`/`_.partial` to create an API with default timeouts etc): e.g node.call("increment", 1).then(assertEqual(2)); node.call({ timeout: 5000 }, "increment", 1).then(assertEqual(2)); ### on(), once(), removeListener() (aliased to .off) listen to events emitted by remote side. arguments as per EventEmitter ### `emit(event : string, data : any) => Promise` emit event heard by remote. returns promise resolved if remote side turned up to heard about it ## Actor API on `RpcPair`s RPCjs also supports the ideas of Actors. You'll frequently be wanting to talk about a given context - actors give you a way to to this without continually resending the same context ID. ### `getActor(id: string) => RemoteActor` Returns an object used to interact with a remote actor. ### `exposeActor(id: string, a: LocalActor) => void` Exposes an actor which the remote side can interact with ### `callActor(id: string, method: string, ...params: Array) => Promise` call a method on an actor by id. ### `expireActor(id: string) => void` Expire a previously exposed actor. Having a separate emitter differentiates from remote events. ## `interface LocalActor { on: (e: string, fn: (...args: any)) => void, expire: () => void )` Interface used by actor system. All optional. Methods called by remote side can be synchronous or return a promise. ## RemoteActor API ### `.call()` - as `rpc.call()` ### `.on(), .off()` etc - as `rpc.on() ...` ### `.get(name: string) => any` Returns value of property on actor at point at which message is received. Serialized/deserialized as JSON. ## Transports Transports are very simple. They call a RpcPair's `.incoming` method with incoming messages, and use `.setSend` to inform a pair that it can send messages via this transport. That's it! Take a look at `transports/streamTransport.js` to see a transport that lets RPCjs work with TCP/UDP/HTTPS or whatever streams you like, however crazy the chain of compression, encryption etc in that stream is! ## Debug To see debug messages, set the DEBUG env var: ```sh DEBUG=rpcjs node yourApp.js ``` --- _Source: https://npm.io/package/rpcjs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._