Class ApiCredentials

A class representation of API-specific user credentials. It encapsulates the tokens and provides helper methods for convenience.

Implements

Interface.ApiCredentials

Index

Constructors

Methods

Properties

accessToken tokenType expiresAt scope?

Constructors

constructor

new ApiCredentials(params: Interface.ApiCredentials): ApiCredentials
Creates an instance of ApiCredentials.
Parameters
- params: Interface.ApiCredentials
  An object conforming to the ApiCredentials type definition.
Returns ApiCredentials
- Defined in core/models/ApiCredentials.ts:18

Methods

isExpired

isExpired(leeway?: number): boolean
Checks if the access token is expired.
Parameters
- Optionalleeway: number = 0
  A buffer in seconds to account for clock skew. The token will be considered expired if it expires within this buffer.
Returns boolean
true if the token is expired, false otherwise.
- Defined in core/models/ApiCredentials.ts:32

Properties

accessToken

accessToken: string

tokenType

tokenType: string

expiresAt

expiresAt: number

`Optional`scope

scope?: string