Have ideas to improve npm?Join in the discussion! »

    vscode-jsonrpc
    TypeScript icon, indicating that this package has built-in type declarations

    6.0.0 • Public • Published

    VSCode JSON RPC

    NPM Version NPM Downloads Build Status

    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.

    import * as cp from 'child_process';
    import * as rpc from 'vscode-jsonrpc';
    
    let childProcess = cp.spawn(...);
    
    // Use stdin and stdout for communication:
    let connection = rpc.createMessageConnection(
    	new rpc.StreamMessageReader(childProcess.stdout),
    	new rpc.StreamMessageWriter(childProcess.stdin));
    
    let notification = new rpc.NotificationType<string, void>('testNotification');
    
    connection.listen();
    
    connection.sendNotification(notification, 'Hello World');

    The server side looks very symmetrical:

    import * as rpc from 'vscode-jsonrpc';
    
    
    let connection = rpc.createMessageConnection(
    	new rpc.StreamMessageReader(process.stdin),
    	new rpc.StreamMessageWriter(process.stdout));
    
    let notification = new rpc.NotificationType<string, void>('testNotification');
    connection.onNotification(notification, (param: string) => {
    	console.log(param); // This prints Hello World
    });
    
    connection.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

    Keywords

    none

    Install

    npm i vscode-jsonrpc

    DownloadsWeekly Downloads

    688,121

    Version

    6.0.0

    License

    MIT

    Unpacked Size

    191 kB

    Total Files

    46

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar