Interface: OAuthClient
Defined in: client.ts:52
A configured OAuth 2.0 client bound to a single provider. Obtain one via
createOAuthClient or a provider preset (e.g. createTikTokClient).
Properties
buildAuthUrl
buildAuthUrl: (
options) =>string
Defined in: client.ts:54
Build the provider's authorization URL to redirect the user to.
Parameters
| Parameter | Type |
|---|---|
options | BuildAuthUrlOptions |
Returns
string
exchangeCode
exchangeCode: (
options) =>Promise<TokenResponse>
Defined in: client.ts:56
Exchange an authorization code for tokens at the token endpoint.
Parameters
| Parameter | Type |
|---|---|
options | ExchangeCodeOptions |
Returns
Promise<TokenResponse>
getValidToken
getValidToken: (
record,options) =>Promise<string>
Defined in: client.ts:64
Return a valid access token, refreshing first if it expires within
refreshWindowMs. On refresh, onRefresh is awaited before returning so
the caller can persist the new tokens.
Parameters
| Parameter | Type |
|---|---|
record | TokenRecord |
options | GetValidTokenOptions |
Returns
Promise<string>
refreshAccessToken
refreshAccessToken: (
refreshToken) =>Promise<TokenResponse>
Defined in: client.ts:58
Refresh an access token using a stored refresh token.
Parameters
| Parameter | Type |
|---|---|
refreshToken | string |
Returns
Promise<TokenResponse>