Type Alias AuthCallback

Type Declaration

• • (
        accept: ClientAcceptCallback,
        reject: ClientRejectCallback,
        handshake: Handshake,
        signal: AbortSignal,
    ): void | Promise<void>

  • Parameters

    • accept: ClientAcceptCallback

      Call this function to accept the connection and cause the server to emit a 'client' event.

    • reject: ClientRejectCallback

      Call this function to reject the connection and cause the server to emit an 'upgradeAborted' event.

    • handshake: Handshake

      Details of the incoming connection (identity, password, headers, query string, remote address, etc.).

    • signal: AbortSignal

      Aborts if the underlying socket is closed before authentication completes. signal.reason is the triggering error and is also available as the error property of the corresponding 'upgradeAborted' event.

    Returns void | Promise<void>