connect-bidi-web
    Preparing search index...

    Interface BidiWebSocketHandlerOptions

    interface BidiWebSocketHandlerOptions {
        contextValues?: ContextValues;
        idleTimeoutMs?: number;
        path?: string;
        webSocketServerOptions?: Omit<
            ServerOptions<typeof WebSocket, typeof IncomingMessage>,
            "noServer" | "server" | "port" | "host" | "path",
        >;
    }
    Index
    contextValues? idleTimeoutMs? path? webSocketServerOptions?
    contextValues?: ContextValues

    Context values made available to handler implementations.

    idleTimeoutMs?: number

    Tears a connection down after this many milliseconds without an incoming frame; see HandleMuxedBidiSocketOptions.idleTimeoutMs.

    path?: string

    The path to accept WebSocket upgrades on when using upgrade(). Defaults to "/websocket". Has no effect on handleConnection().

    webSocketServerOptions?: Omit<
        ServerOptions<typeof WebSocket, typeof IncomingMessage>,
        "noServer" | "server" | "port" | "host" | "path",
    >

    Options forwarded to the underlying ws.WebSocketServer used by upgrade(). noServer is always set by upgrade() and cannot be overridden here.

    Settings
    Member Visibility

    On This Page
    Properties