⚠️ vscode-ws-jsonrpc is deprecated.

Use vscode-ws-jsonrpc instead

---

VSCode WebSocket JSON RPC

NPM module to implement communication between a jsonrpc client and server over WebSocket.

Client side connection handling

1import * as rpc from 'vscode-ws-jsonrpc';
2
3const webSocket = new WebSocket('ws://www.example.com/socketserver');
4rpc.listen({
5    webSocket,
6    onConnection: (connection: rpc.MessageConnection) => {
7        const notification = new rpc.NotificationType<string, void>('testNotification');
8        connection.listen();
9        connection.sendNotification(notification, 'Hello World');
10    }
11});

Server side connection handling

1import * as rpc from 'vscode-ws-jsonrpc';
2
3const socket: rpc.IWebSocket; // open the web socket
4const reader = new rpc.WebSocketMessageReader(socket);
5const writer = new rpc.WebSocketMessageWriter(socket);
6const logger = new rpc.ConsoleLogger();
7const connection = rpc.createMessageConnection(reader, writer, logger);
8const notification = new rpc.NotificationType<string, void>('testNotification');
9connection.onNotification(notification, (param: string) => {
10	console.log(param); // This prints Hello World
11});
12
13connection.listen();

Server side connection forwarding

1import * as rpc from 'vscode-ws-jsonrpc';
2import * as server from 'vscode-ws-jsonrpc/lib/server';
3
4const socket: rpc.IWebSocket; // open the web socket
5const reader = new rpc.WebSocketMessageReader(socket);
6const writer = new rpc.WebSocketMessageWriter(socket);
7const socketConnection = server.createConnection(reader, writer, () => socket.dispose())
8const serverConnection = server.createServerProcess('Example', 'node', ['example.js']);
9server.forward(socketConnection, serverConnection, message => {
10    if (rpc.isNotificationMessage(message)) {
11        if (message.method === 'testNotification') {
12            // handle the test notification
13        }
14    }
15    return message;
16});

License

MIT