GraphReFlyTS

API Reference

domWebSocketDriver()

Adapt a DOM/WebSocket constructor into a graph-local WebSocket driver.

Import

import { domWebSocketDriver } from "@graphrefly/ts/graph";

Signature

function domWebSocketDriver(WebSocketCtor: WebSocketConstructorLike = requireGlobalWebSocket()): LocalWebSocketDriver

Parameters

ParameterTypeDescription
WebSocketCtorWebSocketConstructorLikeWebSocket constructor used to open connections.

Returns

A driver that can connect, send, and optionally stream live sessions.

Example

import { domWebSocketDriver } from "@graphrefly/ts/graph";

const ws = domWebSocketDriver(WebSocket);

Source

packages/ts/src/graph/environment.ts