Class ApiKeyCredential

API Key credential

Hierarchy (View Summary)

AuthCredential
- ApiKeyCredential

Index

Constructors

Properties

Methods

canRefresh getHeaders getToken refresh

Constructors

constructor

new ApiKeyCredential(apiKey: string): ApiKeyCredential
Constructor for ApiKeyCredential
Parameters
- apiKey: string
Returns ApiKeyCredential
Overrides AuthCredential.constructor
- Defined in models/auth/AuthCredential.ts:68

Properties

apiKey

apiKey: string

The API key

type

type: AuthCredentialType

Type of credential

Methods

canRefresh

canRefresh(): boolean
Whether the token can be refreshed

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

getHeaders

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

getToken

getToken(): string
Gets the API key as the token

Returns string
Overrides AuthCredential.getToken
- Defined in models/auth/AuthCredential.ts:76

refresh

refresh(): Promise<void>
Refreshes the token

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