Skip to main content

Function: createWebSocketTransport()

createWebSocketTransport(doBindingName, doInstanceNameOrId, config?): RpcTransport

Defined in: packages/rpc/src/transport-factories.ts:64

Create a WebSocket RPC transport for communicating with a Durable Object.

Parameters​

doBindingName​

string

Name of the DO binding from wrangler.jsonc

doInstanceNameOrId​

string

DO instance name or ID

config?​

Optional transport configuration

additionalProtocols?​

string[]

baseUrl?​

string

clientId?​

string

heartbeatIntervalMs?​

number

onClose?​

(code, reason) => void | Promise<void>

onConnectionChange?​

(connected) => void | Promise<void>

onDownstream?​

(payload) => void | Promise<void>

prefix?​

string

timeout?​

number

WebSocketClass?​

(url, protocols?) => WebSocket

Returns​

RpcTransport

RpcTransport instance for WebSocket communication

Example​

import { createRpcClient, createWebSocketTransport } from '@lumenize/rpc';

const client = createRpcClient({
  transport: createWebSocketTransport('MY_DO', 'instance-1')
});