ws-remote-fn v0.1.0

ws-remote-fn

Call remote functions as if they where local!

Install

npm install --save ws-remote-fn

Usage

Provider

A Provider exposes an API to websocket-clients.

Spec:

Provider = (options, api) => WebSocket.Server

Parameters:

options - WebSocket.Server options (see ws) api - object containing functions only

Example:

const { Provider } = require('ws-remote-fn');

const myApi = {
    myFunction: (x, y, z) => {
        /* ... */
        return something;
    }
}

const myProvider = Provider({ port: 1337 }, myApi);
...

Consumer

A Consumer is a wrapper around a WebSocket-client, acting as a simple object with methods, representing a provider's API.

Spec:

Consumer = (address, options, methods) => object

Parameters:

address - a string to a websocket address (e.g. ws://localhost:1337) options - WebSocket-options (see ws) methods - an array of method names of the remote's API (you don't need this - an automatic discovery is built in)

Example:

const { Consumer } = require('ws-remote-fn');

const remote = Consumer('ws://localhost:1337');
const something = await remote.myFunction(123, 'foobar');