jsonrpc2-ws

Simple, Fast, Robust Implementation of JSON-RPC 2.0 over WebSocket for Node.js w/ TypeScript

[![npm][npm-img]][npm-url]
[![build][travis-img]][travis-url]

Installation

``sh
npm install jsonrpc2-ws --save
`

How to use

$3

`ts
// TypeScript
import { Server as RPCServer } from "jsonrpc2-ws";

const rpc = new RPCServer({
wss: {
port: 3000
}
});

rpc.on("connection", (socket, req) => {
console.log(${socket.id} connected!);

socket.on("close", () => {
console.log(${socket.id} disconnected!);
});

rpc.broadcast("count", { count: rpc.sockets.size });

// room
socket.joinTo("general");
rpc.notifyTo("general", "general.count", { count: rpc.in("general").size });
});

rpc.methods.set("nick", (socket, params) => {
// socket#data is Map to store custom data.
socket.data.set("nick", params.nick);
});

rpc.methods.set("join", (socket, params) => {
if (socket.joinTo(params.ch) === true) {
rpc.notifyTo(params.ch, ${params.ch}.count, { count: rpc.in(params.ch).size });
return;
} else {
throw new Error("Already joined");
}
});

rpc.methods.set("chat", (socket, params) => {
if (!params || !params.ch || !params.message) {
throw new Error("Invalid request");
}

rpc.notifyTo(params.ch, "chat", {
time: Date.now(),
id: socket.id,
nick: socket.data.get("nick") || "anonymous",
ch: params.ch,
message: params.message
});
});

// note: rpc method supports async/await or Promise.
rpc.methods.set("something-async-method", async (socket, params) => {
const res = await somethingAsyncMethod();
return res;
});
`

$3

`ts
// TypeScript
import * as http from "http";
import { Server as RPCServer } from "jsonrpc2-ws";

const server = http.createServer();
const rpc = new RPCServer({ wss: { server } });
`

$3

`ts
// TypeScript
import express = require("express");
import * as http from "http";
import { Server as RPCServer } from "jsonrpc2-ws";

const app = express();
const server = http.createServer(app);
const rpc = new RPCServer({ wss: { server } });
`

Compatibility

- StreamJsonRpc (.NET)

:heart:

BTC: 1CsARqdT2PDLdWng8r2h5pzmyC6xkVnxKw`


License

MIT

[npm-img]: https://img.shields.io/npm/v/jsonrpc2-ws.svg
[npm-url]: https://www.npmjs.com/package/jsonrpc2-ws
[travis-img]: https://img.shields.io/travis/kanreisa/jsonrpc2-ws.svg
[travis-url]: https://travis-ci.org/kanreisa/jsonrpc2-ws