Class AuthCredential`Abstract`

Base class for authentication credentials

Hierarchy (View Summary)

AuthCredential

Index

Constructors

Properties

Methods

canRefresh getHeaders getToken refresh

Constructors

constructor

new AuthCredential(type: AuthCredentialType): AuthCredential
Constructor for AuthCredential
Parameters
- type: AuthCredentialType
Returns AuthCredential
- Defined in models/auth/AuthCredential.ts:27

Properties

type

type: AuthCredentialType

Type of credential

Methods

canRefresh

canRefresh(): boolean
Whether the token can be refreshed

Returns boolean
- Defined in models/auth/AuthCredential.ts:44

`Abstract`getHeaders

getHeaders(config: AuthConfig): Record<string, string>
Gets headers for HTTP requests
Parameters
- config: AuthConfig
Returns Record<string, string>
- Defined in models/auth/AuthCredential.ts:39

`Abstract`getToken

getToken(): undefined | string
Gets the authentication token

Returns undefined | string
- Defined in models/auth/AuthCredential.ts:34

refresh

refresh(): Promise<void>
Refreshes the token

Returns Promise<void>
- Defined in models/auth/AuthCredential.ts:51