JSPM

  • Created
  • Published
  • Downloads 15440
  • Score
    100M100P100Q128792F
  • License MIT

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

Package Exports

  • jsonrpc2-ws
  • jsonrpc2-ws/lib/index.js
  • jsonrpc2-ws/lib/server
  • jsonrpc2-ws/lib/server.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (jsonrpc2-ws) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

jsonrpc2-ws

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

npm build

Installation

npm install jsonrpc2-ws --save

How to use

Standalone

// 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;
});

w/ HTTP server

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

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

w/ Express

// 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

❤️

BTC: 1CsARqdT2PDLdWng8r2h5pzmyC6xkVnxKw

License

MIT