@playlive/realtime-pipeline
    Preparing search index...

    Interface PipelineConnectionOptions

    Options accepted by createPipelineConnection.

    interface PipelineConnectionOptions {
        autoConnect?: boolean;
        identifyDebounceMs?: number;
        identifyDedupeMs?: number;
        keepAliveIntervalMs?: number;
        log?: (msg: string, payload?: unknown) => void;
        maxReconnectAttempts?: number;
        onCommandReload?: () => void;
        reconnectIntervalMs?: number;
        store: StoreApi;
        url?: string;
        webSocketCtor?: WebSocketCtor;
    }
    Index
    autoConnect? identifyDebounceMs? identifyDedupeMs? keepAliveIntervalMs? log? maxReconnectAttempts? onCommandReload? reconnectIntervalMs? store url? webSocketCtor?
    autoConnect?: boolean

    Auto-connect on creation. Default: false — call connect() to start. When true, the connection opens immediately and reconnects until disconnect() is called.

    identifyDebounceMs?: number

    Identify debounce window in ms. Default: 50.

    identifyDedupeMs?: number

    Identify duplicate-suppression window in ms. Default: 500.

    keepAliveIntervalMs?: number

    Keep-alive re-identify interval in ms. Default: 60 000.

    log?: (msg: string, payload?: unknown) => void

    Optional debug logger.

    maxReconnectAttempts?: number

    Reconnect attempt cap. Default: 100 (matches legacy).

    onCommandReload?: () => void

    Reload-on-error callback wired to the "command:reload" server message. Defaults to a browser-only window.location.reload() when globalThis.window is defined.

    reconnectIntervalMs?: number

    Base reconnect delay in ms. Default: 1500 (matches legacy).

    store: StoreApi

    Required vanilla Zustand store created by import("../store").createPipelineStore.

    url?: string

    WebSocket URL to connect to. Defaults to store.getState().wsURL. When supplied, it is written back into the store via setCurrentURL so the rest of the pipeline observes the override.

    webSocketCtor?: WebSocketCtor

    Native WebSocket constructor. Defaults to globalThis.WebSocket. Pass an explicit ctor for environments where the global is missing (older Node) or when tests want to inject a mock.

    Settings
    Member Visibility

    On This Page
    Properties