Class PKCE

An Authenticator class for the OAuth 2.0 Authorization Code with PKCE grant.

Hierarchy (view full)

Authenticator
- PKCE

Index

Constructors

Properties

_accessToken? _authInProgress _expires?

Accessors

Methods

fetchAccessToken setAccessToken tradeCodeForToken

Constructors

constructor

new PKCE(clientId, callback, authServer?, tokenCache?, baseUrl?): PKCE
Parameters
- clientId: string
- callback: string
- OptionalauthServer: string
- tokenCache: TokenCache = localStorageTokenCache
- baseUrl: string = DEFAULT_BASE_URL
Returns PKCE
Overrides Authenticator.constructor
- Defined in authentication/PKCE.ts:12

Properties

`Optional`_accessToken

_accessToken?: string

_authInProgress

_authInProgress: boolean = true

`Optional`_expires

_expires?: number

Accessors

accessToken

get accessToken(): Promise<undefined | string>
Promise that will resolve with an access token if available or undefined otherwise. This will try to fetch a new access token if:
- the class implements the fetchAccessToken method
- no unexpired access token is stored in this class
Returns Promise<undefined | string>
Inherited from Authenticator.accessToken
- Defined in authentication/Authenticator.ts:48

Methods

fetchAccessToken

fetchAccessToken(): Promise<undefined | AccessTokenResponse>
Abstract method that must be implemented by extending classes for specific OAuth 2.0 grants/flows.

Returns Promise<undefined | AccessTokenResponse>
Overrides Authenticator.fetchAccessToken
- Defined in authentication/PKCE.ts:50

setAccessToken

setAccessToken(accessToken, expiresIn): void
Puts an access token and the expiration time in storage for usage when calling Spinque Query API
Parameters
- accessToken: string
- expiresIn: number
Returns void
Inherited from Authenticator.setAccessToken
- Defined in authentication/Authenticator.ts:74

tradeCodeForToken

tradeCodeForToken(code, state): Promise<void>
Parameters
- code: string
- state: string
Returns Promise<void>
- Defined in authentication/PKCE.ts:88