Setu-TS
    Preparing search index...

    Interface GraphqlWsTransportOptions

    WebSocket transport options for GraphQL subscriptions.

    0.3.0

    interface GraphqlWsTransportOptions {
        connectionInitWaitMs?: number;
        heartbeatMs?: number;
        onConnect?: (
            info: GraphqlConnectionInfo,
        ) => false | void | Promise<false | void>;
        path?: string;
    }
    Index
    connectionInitWaitMs? heartbeatMs? onConnect? path?
    connectionInitWaitMs?: number

    Milliseconds to wait for connection_init before closing with code 4408. Default 3000.

    heartbeatMs?: number

    Milliseconds between protocol ping frames. 0 disables. Default 0.

    onConnect?: (
        info: GraphqlConnectionInfo,
    ) => false | void | Promise<false | void>

    Called on connection_init BEFORE the ack. Returning false closes the socket with 4403: Forbidden. May write to conn.data to establish identity for the default resolver context.

    path?: string

    The WebSocket endpoint path; defaults to path without a trailing /, then /ws (/graphql/ → /graphql/ws).

    Settings
    Member Visibility

    On This Page
    Properties