VSCode JSON RPC

This npm module implements the base messaging protocol spoken between a VSCode language server and a VSCode language client.

The npm module can also be used standalone to establish a JSON-RPC channel between a client and a server. Below an example how to setup a JSON-RPC connection. First the client side.

1import * as cp from 'child_process';
2import * as rpc from 'vscode-jsonrpc/node';
3
4let childProcess = cp.spawn(...);
5
6// Use stdin and stdout for communication:
7let connection = rpc.createMessageConnection(
8	new rpc.StreamMessageReader(childProcess.stdout),
9	new rpc.StreamMessageWriter(childProcess.stdin));
10
11let notification = new rpc.NotificationType<string, void>('testNotification');
12
13connection.listen();
14
15connection.sendNotification(notification, 'Hello World');

The server side looks very symmetrical:

1import * as rpc from 'vscode-jsonrpc/node';
2
3
4let connection = rpc.createMessageConnection(
5	new rpc.StreamMessageReader(process.stdin),
6	new rpc.StreamMessageWriter(process.stdout));
7
8let notification = new rpc.NotificationType<string, void>('testNotification');
9connection.onNotification(notification, (param: string) => {
10	console.log(param); // This prints Hello World
11});
12
13connection.listen();

History

5.0.0

• add progress support
• move JS target to ES2017

4.0.0

• move JS target to ES6.

3.0.0:

• converted the NPM module to use TypeScript 2.0.3.
• added strict null support.
• support for passing more than one parameter to a request or notification.
• Breaking changes:
  • due to the use of TypeScript 2.0.3 and differences in d.ts generation users of the new version need to move to TypeScript 2.0.3 as well.

License

MIT