# @codingame/monaco-jsonrpc

> VSCode JSON RPC over WebSocket

Latest version **0.4.1** (published 2022-06-21) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @codingame/monaco-jsonrpc
pnpm add @codingame/monaco-jsonrpc
yarn add @codingame/monaco-jsonrpc
bun add @codingame/monaco-jsonrpc
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.4.1 |
| Published | 2022-06-21 |
| First published | 2020-11-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 48.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | TypeFox GmbH |
| Maintainers | codingame_team, nantoniazzi, samuel.olivier, maximecg, beli4l, nonofr |

## Links

- npm: https://www.npmjs.com/package/@codingame/monaco-jsonrpc
- Repository: https://github.com/CodinGame/monaco-jsonrpc
- Homepage: https://github.com/CodinGame/monaco-jsonrpc#readme
- Issues: https://github.com/CodinGame/monaco-jsonrpc/issues
- npm.io page: https://npm.io/package/@codingame/monaco-jsonrpc

## Dependencies (1)

- [vscode-jsonrpc](https://npm.io/package/vscode-jsonrpc.md) ^8.0.1

## Recent versions

- 0.4.1 (latest) — 2022-06-21
- 0.4.0 — 2022-05-13
- 0.3.1 — 2021-02-03
- 0.3.0 — 2020-11-24

## README

:warning: __@CodinGame/monaco-jsonrpc is deprecated.__

Use [vscode-ws-jsonrpc](https://github.com/TypeFox/monaco-languageclient/tree/main/packages/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
```ts
import * as rpc from 'monaco-jsonrpc';

const webSocket = new WebSocket('ws://www.example.com/socketserver');
rpc.listen({
    webSocket,
    onConnection: (connection: rpc.MessageConnection) => {
        const notification = new rpc.NotificationType<string, void>('testNotification');
        connection.listen();
        connection.sendNotification(notification, 'Hello World');
    }
});
```

### Server side connection handling
```ts
import * as rpc from 'monaco-jsonrpc';

const socket: rpc.IWebSocket; // open the web socket
const reader = new rpc.WebSocketMessageReader(socket);
const writer = new rpc.WebSocketMessageWriter(socket);
const logger = new rpc.ConsoleLogger();
const connection = rpc.createMessageConnection(reader, writer, logger);
const notification = new rpc.NotificationType<string, void>('testNotification');
connection.onNotification(notification, (param: string) => {
	console.log(param); // This prints Hello World
});

connection.listen();
```

### Server side connection forwarding
```ts
import * as rpc from 'monaco-jsonrpc';
import * as server from 'monaco-jsonrpc/lib/server';

const socket: rpc.IWebSocket; // open the web socket
const reader = new rpc.WebSocketMessageReader(socket);
const writer = new rpc.WebSocketMessageWriter(socket);
const socketConnection = server.createConnection(reader, writer, () => socket.dispose())
const serverConnection = server.createServerProcess('Example', 'node', ['example.js']);
server.forward(socketConnection, serverConnection, message => {
    if (rpc.isNotificationMessage(message)) {
        if (message.method === 'testNotification') {
            // handle the test notification
        }
    }
    return message;
});
```

## License
[MIT](https://github.com/CodinGame/monaco-jsonrpc/blob/master/License.txt)

---
_Source: https://npm.io/package/@codingame/monaco-jsonrpc · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._