Class AccessTokenRefresher

Package version

Helps the core-http token authentication policies with requesting a new token if we're not currently waiting for a new token.

Hierarchy

AccessTokenRefresher

Index

Constructors

constructor

Methods

Constructors

constructor

new AccessTokenRefresher(credential: TokenCredential, scopes: string | string[], requiredMillisecondsBeforeNewRefresh?: number): AccessTokenRefresher

- Defined in home/vsts/work/1/s/sdk/core/core-http/src/credentials/accessTokenRefresher.ts:11
Parameters
- credential: TokenCredential
- scopes: string | string[]
- Default value requiredMillisecondsBeforeNewRefresh: number = 30000
Returns AccessTokenRefresher

Methods

isReady

isReady(): boolean

- Defined in home/vsts/work/1/s/sdk/core/core-http/src/credentials/accessTokenRefresher.ts:23
Returns true if the required milliseconds(defaulted to 30000) have been passed signifying that we are ready for a new refresh.

Returns boolean

refresh

refresh(options: GetTokenOptions): Promise<AccessToken | undefined>

- Defined in home/vsts/work/1/s/sdk/core/core-http/src/credentials/accessTokenRefresher.ts:47
Requests a new token if we're not currently waiting for a new token. Returns null if the required time between each call hasn't been reached.

Parameters
- options: GetTokenOptions
Returns Promise<AccessToken | undefined>

Generated using TypeDoc