Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/radarsu/rpc-websocket-client
Fast and simple JSON-RPC 2.0 WebSocket Client implementation in TypeScript. Allows bi-directional communication with async await Promises 🐼
https://github.com/radarsu/rpc-websocket-client
bidirectional communication fast fast-json-stringify javascript javascript-library jsonrpc2 lightweight notifications requests rpc rpc-client rpc-websockets typescript typescript-library uuid websocket websocket-client
Last synced: 3 months ago
JSON representation
Fast and simple JSON-RPC 2.0 WebSocket Client implementation in TypeScript. Allows bi-directional communication with async await Promises 🐼
- Host: GitHub
- URL: https://github.com/radarsu/rpc-websocket-client
- Owner: radarsu
- License: mit
- Created: 2018-11-03T19:49:03.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2023-02-02T22:28:39.000Z (almost 2 years ago)
- Last Synced: 2023-02-27T08:12:19.564Z (almost 2 years ago)
- Topics: bidirectional, communication, fast, fast-json-stringify, javascript, javascript-library, jsonrpc2, lightweight, notifications, requests, rpc, rpc-client, rpc-websockets, typescript, typescript-library, uuid, websocket, websocket-client
- Language: TypeScript
- Homepage: https://radarsu.radrat.pl/rpc-websocket-client/
- Size: 2.01 MB
- Stars: 31
- Watchers: 8
- Forks: 8
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Fast JSON RPC 2.0 written in TypeScript.
TypeScript JSON RPC 2.0 WebSocket implementation with async-await Promises.
[](https://www.buymeacoffee.com/radarsu)
## Description
I really lacked typescript support or type definitions of rpc-websockets. I kept everything as simple as possible for best performance and in principle stay close to the metal. Under the hood id-generation for requests is done using uuid/v1 to provide id uniqueness as an additional feature.
## Installation
```sh
npm i rpc-websocket-client
```
## Features
- TypeScript with documentation in comments.
- Unique RPC identifiers by uuid/v1.
- Lightweight. Allows you to call `noRpc()` method to prevent sending `jsonrpc: '2.0'` overhead from all messages if you'd like to ignore the JSON RPC 2.0 standard for better performance.
- Option to connect RpcWebSocketClient with already existing WebSocket with `changeSocket()` and `listenMessages()` methods. Useful if you use REST or GraphQL implementation from another library and want to handle JSON RPC 2.0 when communicating from server to client (that was my use case to develop this package).
## Basic Usage
```ts
import { RpcWebSocketClient } from 'rpc-websocket-client';
(async () => {
const rpc = new RpcWebSocketClient();
await rpc.connect(`ws://localhost:4000/`);
// Connection is established now.
// Let's hope there will be no error or it will be catched in some wrapper.
await rpc.call(`auth.login`, [`rpcMaster`, `mySecretPassword`]);
// Now lets be pesimistic.
const res = await rpc.call(`auth.login`, [`rpcMaster`, `mySecretPassword`]).then(() => {
// Woohoo, user logged!
}).catch((err) => {
// Err is typeof RpcError (code: number, message: string, data?: any).
await rpc.call(`auth.signup`, {
login: `rpcMaster`,
password: `mySecretPassword`,
});
return false;
});
// If catch wrapper returned false, let's not continue.
if (res === false) {
return;
}
rpc.notify(`btw.iHateYou`, [`over and out`]);
// Close the connection by using native ws.close().
rpc.ws.close();
})();
```
## Advanced Usage
```ts
import { RpcWebSocketClient } from 'rpc-websocket-client';
(async () => {
// lets say you use WebSocket implementation for GraphQL Client -> Server communication
// e.g. Apollo, and it's already connected
// but you want to handle some of the Server -> Client communication with RPC
const ws = (apollo as any).client.wsImpl;
const rpc = new RpcWebSocketClient();
rpc.onRequest.push((data) => { // data is typeof RpcRequest
// controller-like stuff
});
rpc.onNotification.push((data) => { // data is typeof RpcNotification
// notification handling
});
// here goes magic for listening to already-connected socket
rpc.changeSocket(ws);
rpc.listenMessages();
})();
```