Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebSocketServerTransportOptions

Hierarchy

  • ServerOptions
    • WebSocketServerTransportOptions

Index

Properties

Methods

Properties

authentication

authentication: readonly AuthProvider[]

Authentication providers to use for this transport.

Optional backlog

backlog?: number

Optional clientTracking

clientTracking?: boolean

Optional host

host?: string

Optional maxPayload

maxPayload?: number

Optional noServer

noServer?: boolean

Optional path

path?: string

Optional perMessageDeflate

perMessageDeflate?: boolean | PerMessageDeflateOptions

Optional port

port?: number

Optional server

server?: Server | Server

Optional skipUTF8Validation

skipUTF8Validation?: boolean

Optional verifyClient

verifyClient?: VerifyClientCallbackAsync | VerifyClientCallbackSync

Methods

Optional handleProtocols

  • handleProtocols(protocols: Set<string>, request: IncomingMessage): string | false

  • Parameters

    • protocols: Set<string>
    • request: IncomingMessage

    Returns string | false

Generated using TypeDoc