Interface ServerOptions

interface ServerOptions {
    WebSocket?: typeof WebSocket;
    backlog?: number;
    clientTracking?: boolean;
    handleProtocols?: ((protocols, request) => string | false);
    host?: string;
    maxPayload?: number;
    noServer?: boolean;
    path?: string;
    perMessageDeflate?: boolean | PerMessageDeflateOptions;
    port?: number;
    server?: Server<typeof IncomingMessage, typeof ServerResponse> | Server<WebSocket>;
    skipUTF8Validation?: boolean;
    verifyClient?: VerifyClientCallbackSync | VerifyClientCallbackAsync;
}

Index

Properties

WebSocket? backlog? clientTracking? handleProtocols? host? maxPayload? noServer? path? perMessageDeflate? port? server? skipUTF8Validation? verifyClient?

Properties

`Optional` WebSocket

WebSocket?: typeof WebSocket

`Optional` backlog

backlog?: number

`Optional` clientTracking

clientTracking?: boolean

`Optional` handleProtocols

handleProtocols?: ((protocols, request) => string | false)

Type declaration

- (protocols, request): string | false
- Parameters
  - protocols: Set<string>
  - request: IncomingMessage
  Returns string | false

`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<typeof IncomingMessage, typeof ServerResponse> | Server<WebSocket>

`Optional` skipUTF8Validation

skipUTF8Validation?: boolean

`Optional` verifyClient

verifyClient?: VerifyClientCallbackSync | VerifyClientCallbackAsync