Interface: BearerAuthContextData<FetcherConfig>
Type parameters#
| Name | Type |
|---|---|
FetcherConfig | extends Tokens |
Properties#
fetcherConfig#
• fetcherConfig: FetcherConfig
Generic configuration to be consumed by fetcher. Includes pair of tokens: bearer token and refresh token.
isRefreshing#
• isRefreshing: MutableRefObject<boolean>
Boolean flag telling whether token refresh is currently in progress.
Methods#
setTokens#
â–¸ setTokens(tokens): void
Manually sets tokens.
Parameters#
| Name | Type |
|---|---|
tokens | Tokens |
Returns#
void
clearTokens#
â–¸ clearTokens(): void
Manually clears tokens.
Returns#
void
hasTokenExpired#
â–¸ hasTokenExpired(error): boolean
Runs when request fails. Checks whether request failed because of expired token.
Parameters#
| Name | Type | Description |
|---|---|---|
error | any | any error returned by API |
Returns#
boolean
triggerRefresh#
â–¸ triggerRefresh(): Promise<null | Tokens>
Manually trigger token refresh.
Returns#
Promise<null | Tokens>
tokenAwaiter#
â–¸ tokenAwaiter(): Promise<null | Tokens>
Returns Promise that resolves when token is done refreshing. To be used in conjunction with triggerRefresh.
Returns#
Promise<null | Tokens>
setRefreshFailureHandler#
â–¸ setRefreshFailureHandler(handler): void
Set callback to be called when token refresh fails. Re-exported as useRefreshFailureHandler() hook.
Parameters#
| Name | Type |
|---|---|
handler | null | RefreshFailureHandler |
Returns#
void
setRefreshSuccessHandler#
â–¸ setRefreshSuccessHandler(handler): void
Set callback to be called when token refresh succeeds. Re-exported as useRefreshSuccessHandler() hook.
Parameters#
| Name | Type |
|---|---|
handler | null | RefreshSuccessHandler |
Returns#
void