Variable WebSocketsConst

Type Declaration

• clear: function

  • clear(): void

    Returns void

• continuous: function

  • continuous(
        route: string | RequestEvent<Record<string, never>, "/" | null> | URL,
        config?: Omit<WebSocketEndpointConfig, "disposer" | "path">,
    ): WebSocketEndpointController

    Parameters

    • route: string | RequestEvent<Record<string, never>, "/" | null> | URL
    • Optionalconfig: Omit<WebSocketEndpointConfig, "disposer" | "path">

    Returns WebSocketEndpointController

• raw: function

  • raw(
        route: string | RequestEvent<Record<string, never>, "/" | null> | URL,
        handle: UpgradeHandle,
    ): void

    Parameters

    • route: string | RequestEvent<Record<string, never>, "/" | null> | URL
    • handle: UpgradeHandle

    Returns void

• upgrade: function

  • upgrade(req: IncomingMessage, socket: Duplex, head: Buffer): Promise<void>

    Parameters

    • req: IncomingMessage
    • socket: Duplex
    • head: Buffer

    Returns Promise<void>

• use: function

  • use(
        route: string | RequestEvent<Record<string, never>, "/" | null> | URL,
        connectionHandler: (
            ws: ReferencedWebSocket,
            controller: WebSocketEndpointController,
        ) => unknown,
        config?: Omit<WebSocketEndpointConfig, "disposer" | "path" | "limit">,
    ): string

    Parameters

    • route: string | RequestEvent<Record<string, never>, "/" | null> | URL
    • connectionHandler: (ws: ReferencedWebSocket, controller: WebSocketEndpointController) => unknown
    • Optionalconfig: Omit<WebSocketEndpointConfig, "disposer" | "path" | "limit">

    Returns string