Class CustomHeaderAuthenticator

Hierarchy-Diagram

UML class diagram of CustomHeaderAuthenticator

Legend

icon for a class in the UML class diagram

class

icon for an interface in the UML class diagram

interface

icon for a private property in the UML class diagram

private property

icon for a public method in the UML class diagram

public method

Hierarchy

CustomHeaderAuthenticator

Implements

TapjawAuthenticator<HttpHeaders>

Index

Constructors

constructor

Properties

headers

Methods

Constructors

constructor

new CustomHeaderAuthenticator(headers: CustomHeaders[]): CustomHeaderAuthenticator

- Defined in src/authenticators/custom-header-authenticator.ts:8
Parameters
- headers: CustomHeaders[]
Returns CustomHeaderAuthenticator

Properties

Private headers

headers: Record<string, string>

Methods

authenticate

authenticate(): Promise<HttpHeaders>

Implementation of TapjawAuthenticator.authenticate
- Defined in src/authenticators/custom-header-authenticator.ts:19
Run authentication routine and pass the authentication data into the connector.

Returns Promise<HttpHeaders>

isAuthenticated

isAuthenticated(): boolean

Implementation of TapjawAuthenticator.isAuthenticated
- Defined in src/authenticators/custom-header-authenticator.ts:15
Whether the authentication has occurred.

Returns boolean
boolean

Generated using TypeDoc