Skip to main content

@livon/node-ws-transport

npm Package Size Security Scorecard CI

Purpose​

Node transport adapter for @livon/runtime.
It maps websocket wire envelopes to deterministic runtime envelopes.

Best for​

Use this package when backend services expose LIVON over WebSocket.

Install​

pnpm add @livon/node-ws-transport

Basic usage​

import {runtime} from '@livon/runtime';
import {nodeWsTransport} from '@livon/node-ws-transport';

runtime(nodeWsTransport({server: wsServer}));

Parameters in this example​

nodeWsTransport({...}):

  • server (WebSocketServerLike, required): websocket server instance from your host runtime.
  • onError ((error, info) => void, optional): transport-level error callback.
  • getClientContext ((info) => RuntimeEventContext, optional): maps client metadata to event context.
  • onClientClose ((info) => void, optional): close callback for cleanup.
  • encode ((envelope) => Uint8Array, optional): custom envelope encoder.
  • decode ((bytes) => envelope, optional): custom envelope decoder.

Runtime context fields​

The transport enriches event context with:

  • transport: 'ws'
  • clientId: string