Class TokenRefresher

Class responsible for refreshing OAuth2 access tokens

Index

Constructors

Methods

refreshTokens revokeToken

Constructors

constructor

new TokenRefresher(
auth: OAuth2,
onRefresh: (tokens: AccessTokens) => void | Promise<void>,
): TokenRefresher
Parameters
- auth: OAuth2
- onRefresh: (tokens: AccessTokens) => void | Promise<void>
Returns TokenRefresher
- Defined in src/oauth/tokenRefresher.ts:28

Methods

refreshTokens

refreshTokens(
refreshToken: string,
opts?: OAuth2RequestOptions,
): Promise<AccessTokens>
Attempt token refresh using given refresh token
Parameters
- refreshToken: string
  refresh token to use in request with token issuer
- Optionalopts: OAuth2RequestOptions
  optional settings for the request. If a refresh is already in flight, that request's settings apply and these are ignored.
Returns Promise<AccessTokens>

Throws
when token refresh fails
- Defined in src/oauth/tokenRefresher.ts:40

revokeToken

revokeToken(
    token: string,
    type?: "access_token" | "refresh_token",
    opts?: OAuth2RequestOptions,
): Promise<void>
Revoke a token with the OP, e.g. as part of logging out.
Parameters
- token: string
  the token to revoke
- Optionaltype: "access_token" | "refresh_token"
  the type of token, acts as a hint to the OP
- Optionalopts: OAuth2RequestOptions
  optional settings for the request
Returns Promise<void>

Throws
when revocation fails
- Defined in src/oauth/tokenRefresher.ts:66