Class PKCE

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

Hierarchy

Constructors

constructor

Properties

_accessToken? _authInProgress _expires? authServer? baseUrl callback clientId

Accessors

accessToken

Methods

authorize checkForCallback fetchAccessToken setAccessToken tradeCodeForToken

Constructors

constructor

Properties

Optional _accessToken

_accessToken?: string

_authInProgress

_authInProgress: boolean = true

Optional _expires

_expires?: number

Private Optional authServer

authServer?: string

Private baseUrl

baseUrl: string = DEFAULT_BASE_URL

Private callback

callback: string

Private clientId

clientId: string

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>

Methods

Private authorize

Private checkForCallback

fetchAccessToken

setAccessToken

tradeCodeForToken

  • Parameters

    • code: string
    • state: string

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc