Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServerOptions

Hierarchy

  • ServerOptions

Index

Properties

Methods

Properties

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 | WebSocket.PerMessageDeflateOptions

Optional port

port?: number

Optional server

server?: Server<typeof IncomingMessage, typeof ServerResponse> | Server<typeof IncomingMessage, typeof ServerResponse>

Optional skipUTF8Validation

skipUTF8Validation?: boolean

Optional verifyClient

verifyClient?: WebSocket.VerifyClientCallbackAsync | WebSocket.VerifyClientCallbackSync

Methods

Optional handleProtocols

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

  • Parameters

    • protocols: Set<string>
    • request: IncomingMessage

    Returns string | false