Class UnsecureConstantCredentialsExtractor

Credentials extractor that authenticates a constant agent (useful for development or debugging purposes).

Hierarchy

CredentialsExtractor
- UnsecureConstantCredentialsExtractor

Index

Constructors

constructor

Properties

agent
logger

Methods

Constructors

constructor

new UnsecureConstantCredentialsExtractor(agent: string | Credentials): UnsecureConstantCredentialsExtractor

- Defined in src/authentication/UnsecureConstantCredentialsExtractor.ts:11
Parameters
- agent: string | Credentials
Returns UnsecureConstantCredentialsExtractor

Properties

Private Readonly agent

agent: Credentials

Private Readonly logger

logger: Logger = getLoggerFor(this)

Methods

canHandle

canHandle(input: HttpRequest): Promise<void>

Inherited from AsyncHandler.canHandle
- Defined in src/util/AsyncHandler.ts:13
Checks if the input data can be handled by this class. Throws an error if it can't handle the data.

Parameters
- input: HttpRequest
  
  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.

handle

handle(): Promise<Credentials>

Overrides AsyncHandler.handle
- Defined in src/authentication/UnsecureConstantCredentialsExtractor.ts:18
Returns Promise<Credentials>

handleSafe

handleSafe(data: HttpRequest): Promise<Credentials>

Inherited from AsyncHandler.handleSafe
- Defined in src/util/AsyncHandler.ts:33
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: HttpRequest
  
  The data to handle.
Returns Promise<Credentials>

The result of the handle function of the handler.