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

    Interface PipelineConnection

    Public API returned by createPipelineConnection.

    interface PipelineConnection {
        connect: () => void;
        destroy: () => void;
        disconnect: () => void;
        identify: () => void;
        off: <E extends keyof PipelineConnectionEvents>(
            event: E,
            cb: PipelineConnectionEvents[E],
        ) => void;
        on: <E extends keyof PipelineConnectionEvents>(
            event: E,
            cb: PipelineConnectionEvents[E],
        ) => () => void;
        readyState: number;
        refresh: (filters?: RefreshCommandFilters) => void;
        send: (data: string) => void;
    }
    Index
    connect destroy disconnect identify off on readyState refresh send
    connect: () => void

    Open the connection (idempotent).

    destroy: () => void

    Force-tear-down everything including the store subscription.

    disconnect: () => void

    Close the connection and stop reconnecting.

    identify: () => void

    Trigger a debounced identify.

    off: <E extends keyof PipelineConnectionEvents>(
        event: E,
        cb: PipelineConnectionEvents[E],
    ) => void

    Remove a lifecycle listener.

    on: <E extends keyof PipelineConnectionEvents>(
        event: E,
        cb: PipelineConnectionEvents[E],
    ) => () => void

    Register a lifecycle listener. Returns an unsubscribe function.

    readyState: number

    Current ready state (mirrors WebSocket.readyState).

    refresh: (filters?: RefreshCommandFilters) => void

    Send an admin refresh command. No-op if not connected.

    send: (data: string) => void

    Send a raw frame. No-op if not connected.

    Settings
    Member Visibility

    On This Page
    Properties