Github Link
      ⚠️ Internal: This API is not publically exported by the package.

      Interface ServerOptions<U, V>

      interface ServerOptions {
          WebSocket?: U;
          backlog?: number;
          clientTracking?: boolean;
          handleProtocols?: ((protocols, request) => 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>>;
      }

      Type Parameters

      Properties

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

      Properties

      Optional WebSocket

      WebSocket?: U

      Optional backlog

      backlog?: number

      Optional clientTracking

      clientTracking?: boolean

      Optional handleProtocols

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

      Type declaration

        • (protocols, request): string | false

        • Parameters

          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<V, typeof ServerResponse> | Server<V, typeof ServerResponse>

      Optional skipUTF8Validation

      skipUTF8Validation?: boolean

      Optional verifyClient

      verifyClient?: VerifyClientCallbackAsync<InstanceType<V>> | VerifyClientCallbackSync<InstanceType<V>>

      Settings

      Member Visibility

      Theme

      On This Page