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

Type Parameters

Properties

backlog?: number
clientTracking?: boolean
handleProtocols?: (
    protocols: Set<string>,
    request: InstanceType<V>,
) => string | false
host?: string
maxPayload?: number
noServer?: boolean
path?: string
perMessageDeflate?: boolean | PerMessageDeflateOptions
port?: number
server?: Server<V, typeof ServerResponse> | Server<V, typeof ServerResponse>
skipUTF8Validation?: boolean
verifyClient?:
    | VerifyClientCallbackAsync<InstanceType<V>>
    | VerifyClientCallbackSync<InstanceType<V>>
WebSocket?: U