Node-ws-rpc NPM

node-ws-rpc

Rpc client built on persistent ws connections. Uses http status codes.

Getting Started

npm install --save node-ws-rpc

Basic Usage

const { Client, Server } = require('node-ws-rpc');

// Create a server
const methods = {
	createUser(req) {
		const user = { name: req.body.name };
		req.reply(201, { user });
	},
};

const server = Server({ port: 3000 }, methods);


// Create a client
const client = Client('ws://localhost:3000');

client.call('createUser', { name: 'Dan' })
	.then((resp) => {
		console.log('Status:', resp.statusCode);
		console.log('User:', resp.body.user);
	})
	.catch((err) => {
		console.log(err.statusCode);
		console.log(err.body);
	});


// Detect when the persistent connection is closed
client.on('close', () => {
	console.log('Connection closed...');
});


// Later on... Manually close the connection
client.close();

Client

wsRpc.Client(address, socketOptions, rpcOptions)

address and socketOptions will be passed directly to the ws module when creating the socket.
rpcOptions:

connectionTimeout: how long to wait before closing the socket if the server is not responding to heartbeats.
heartbeatPeriod: how often to ping the server.

client.call(methodName, body, options)

Send a message to the server. Returns a promise. options:

Takes all options from rxjs-backoff.
timeout: Time to wait before throwing an error on a given attempt. If maxRetries is zero (default) then this will be the total time.

// Default options
initialDelay: 200,
maxDelay: 1000,
maxRetries: 0,
multiplier: 2,
retryWhen: () => true,
timeout: 5000,

client.on(eventName, callback)

Subscribe to an event. Valid event names: ['close', 'error'].

client.close()

Close the socket. Will fire the close event if it hasn't already fired.

Server

wsRpc.Server(socketOptions, methods, rpcOptions)

socketOptions will be passed directly to the ws module when creating the socket.
methods is a dictionary containing all the callable functions. A client will get a 404 if they call a function that is not defined here. rpcOptions:

connectionTimeout: how long to wait before closing the socket if the client is not responding to heartbeats.
heartbeatPeriod: how often to ping the client.