Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CredentialsExtractor

Responsible for extracting credentials from an incoming request.

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

canHandle

  • canHandle(input: Guarded<IncomingMessage>): Promise<void>

  • Checks if the input data can be handled by this class. Throws an error if it can't handle the data.

    Parameters

    • input: Guarded<IncomingMessage>

      Input data that would be handled potentially.

    Returns Promise<void>

    A promise resolving if this input can be handled, rejecting with an Error if not.

Abstract handle

  • Handles the given input. This should only be done if the canHandle function returned true.

    Parameters

    • input: Guarded<IncomingMessage>

      Input data that needs to be handled.

    Returns Promise<Credentials>

    A promise resolving when the handling is finished. Return value depends on the given type.

handleSafe

  • Helper function that first runs the canHandle function followed by the handle function. Throws the error of the canHandle function if the data can't be handled, or returns the result of the handle function otherwise.

    Parameters

    • data: Guarded<IncomingMessage>

      The data to handle.

    Returns Promise<Credentials>

    The result of the handle function of the handler.