Registry / devops / multi-rpc-websocket-transport

multi-rpc-websocket-transport

JSON →
library2.0.1jsnpmunverified

WebSocket transport layer for multi-rpc (v2.0.1). Provides client and server WebSocket connections for the multi-rpc RPC framework. Requires multi-rpc-common ^3.x. Supports ESM via TypeScript. Release cadence is irregular; stable as of v2.0.1. Differentiated as the official WebSocket transport for multi-rpc, leveraging the ws library.

npm install multi-rpc-websocket-transport
INSTALL
IMPORT
SIG · MULTI-RPC-WEBSOCKE
M
multi-rpc-websocket-transport
devopsjavascriptv2.0.1
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

WebSocketTransportClient
import { WebSocketTransportClient } from 'multi-rpc-websocket-transport'
const { WebSocketTransportClient } = require('multi-rpc-websocket-transport')
ESM-only since v2; CommonJS require not supported without bundler. Use dynamic import if needed.
WebSocketTransportServer
import { WebSocketTransportServer } from 'multi-rpc-websocket-transport'
import WebSocketTransportServer from 'multi-rpc-websocket-transport'
Named export only; default export not available.
default
import { WebSocketTransportClient } from 'multi-rpc-websocket-transport'
import Transport from 'multi-rpc-websocket-transport'
No default export; use named exports.

Shows basic client-server setup using WebSocket transport with multi-rpc-common.

import { WebSocketTransportClient, WebSocketTransportServer } from 'multi-rpc-websocket-transport'; import { RPCClient, RPCServer } from 'multi-rpc-common'; // Server const serverTransport = new WebSocketTransportServer({ port: 8080 }); const rpcServer = new RPCServer(serverTransport); rpcServer.register('greet', (name: string) => `Hello, ${name}!`); // Client const clientTransport = new WebSocketTransportClient({ url: 'ws://localhost:8080' }); const rpcClient = new RPCClient(clientTransport); const result = await rpcClient.call('greet', 'World'); console.log(result); // "Hello, World!" clientTransport.close(); serverTransport.close();
Debug
Known issues
breakingDropped CJS support in v2; module is ESM-only.
fix
Use ESM imports or bundler transcoding. Update tsconfig with "module": "ESNext".
affects: >=2.0.0
deprecatedv1.x deprecated; v2 uses ws v8.x.
fix
Upgrade to v2.0.0 and adjust API (options shape changed).
affects: >=1.0.0 <2.0.0
gotchaTransport requires ws library but does not expose its own WebSocket polyfill.
fix
Ensure ws is installed. In browser, provide a polyfill or use a bundler that shims.
affects: *
breakingOptions object for WebSocketTransportClient changed from v1 to v2: 'host'/'port' replaced by 'url'.
fix
Use { url: 'ws://...' } instead of { host: '...', port: 1234 }.
affects: >=2.0.0
gotchaWebSocketTransportServer does not auto-start; must call listen() or pass port in constructor.
fix
Either pass { port } to constructor or call serverTransport.listen(port).
affects: >=2.0.0
Errors
Common errors & fixes
Error: Cannot find module 'multi-rpc-websocket-transport'
Package not installed or import path incorrect.
fix
Run: npm install multi-rpc-websocket-transport multi-rpc-common
TypeError: WebSocketTransportClient is not a constructor
Default import used instead of named import.
fix
Use: import { WebSocketTransportClient } from 'multi-rpc-websocket-transport'
Error: The ESM module 'multi-rpc-websocket-transport' cannot be loaded with require()
CommonJS require used on an ESM-only package.
fix
Use dynamic import: const { WebSocketTransportClient } = await import('multi-rpc-websocket-transport')
Upgrade
Version history
2.0.1latest on npm
Audit
Dependencies
multi-rpc-commonrequiredpeer dependency providing core RPC types and interfaces
wsrequiredruntime dep for WebSocket client/server implementation
Agent activity
7 hits · last 30 days
node
6
Amazon
1
Resources
multi-rpc-websocket-transport — npm install multi-rpc-websocket-transport · libregistry