Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace WebSocket

Index

References

Interfaces

Type aliases

Variables

Functions

References

Server

Re-exports Server

ServerOptions

Re-exports ServerOptions

Type aliases

CertMeta

CertMeta: string | string[] | Buffer | Buffer[]

CertMeta represents the accepted types for certificate & key data.

Data

Data: string | Buffer | ArrayBuffer | Buffer[]

Data represents the message payload received over the WebSocket.

RawData

RawData: Buffer | ArrayBuffer | Buffer[]

Data represents the raw message payload received over the WebSocket.

VerifyClientCallbackAsync

VerifyClientCallbackAsync: (info: { origin: string; req: IncomingMessage; secure: boolean }, callback: (res: boolean, code?: number, message?: string, headers?: OutgoingHttpHeaders) => void) => void

Type declaration

    • (info: { origin: string; req: IncomingMessage; secure: boolean }, callback: (res: boolean, code?: number, message?: string, headers?: OutgoingHttpHeaders) => void): void

    • VerifyClientCallbackAsync is an asynchronous callback used to inspect the incoming message. The return value (boolean) of the function determines whether or not to accept the handshake.

      Parameters

      • info: { origin: string; req: IncomingMessage; secure: boolean }
        • origin: string
        • req: IncomingMessage
        • secure: boolean
      • callback: (res: boolean, code?: number, message?: string, headers?: OutgoingHttpHeaders) => void
          • (res: boolean, code?: number, message?: string, headers?: OutgoingHttpHeaders): void

          • Parameters

            • res: boolean
            • Optional code: number
            • Optional message: string
            • Optional headers: OutgoingHttpHeaders

            Returns void

      Returns void

VerifyClientCallbackSync

VerifyClientCallbackSync: (info: { origin: string; req: IncomingMessage; secure: boolean }) => boolean

Type declaration

    • (info: { origin: string; req: IncomingMessage; secure: boolean }): boolean

    • VerifyClientCallbackSync is a synchronous callback used to inspect the incoming message. The return value (boolean) of the function determines whether or not to accept the handshake.

      Parameters

      • info: { origin: string; req: IncomingMessage; secure: boolean }
        • origin: string
        • req: IncomingMessage
        • secure: boolean

      Returns boolean

WebSocket

WebSocket: WebSocketAlias

WebSocketServer

WebSocketServer: Server

Variables

Const WebSocket

WebSocket: typeof WebSocketAlias

Const WebSocketServer

WebSocketServer: typeof Server

Functions

createWebSocketStream

  • createWebSocketStream(websocket: WebSocket, options?: DuplexOptions): Duplex

  • Parameters

    • websocket: WebSocket
    • Optional options: DuplexOptions

    Returns Duplex