VSCode WebSocket JSON RPC

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

See the following example code how to use this library or take a look of the monaco-languageclient and vscode-ws-jsonrpc examples here:

• client
• server

Client side connection handling

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

Server side connection handling

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

Server side connection forwarding

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

License

MIT