bearer-auth-react-context
Interfaces#
Type aliases#
RefreshHandler#
Ƭ RefreshHandler<FetcherConfig>: (fetcherConfig: FetcherConfig) => Promise<Tokens>
Type parameters#
| Name | Type |
|---|---|
FetcherConfig | extends Tokens |
Type declaration#
â–¸ (fetcherConfig): Promise<Tokens>
Parameters#
| Name | Type |
|---|---|
fetcherConfig | FetcherConfig |
Returns#
Promise<Tokens>
RefreshSuccessHandler#
Ƭ RefreshSuccessHandler: (tokens: Tokens) => void
Type declaration#
â–¸ (tokens): void
Parameters#
| Name | Type |
|---|---|
tokens | Tokens |
Returns#
void
RefreshFailureHandler#
Ƭ RefreshFailureHandler: (error: unknown) => void
Type declaration#
â–¸ (error): void
Parameters#
| Name | Type |
|---|---|
error | unknown |
Returns#
void
Functions#
BearerAuthContextProvider#
â–¸ BearerAuthContextProvider<FetcherConfig>(props): Element
Type parameters#
| Name |
|---|
FetcherConfig |
Parameters#
| Name | Type |
|---|---|
props | PropsWithChildren<BearerAuthContextProviderProps<FetcherConfig>> |
Returns#
Element
useBearerAuthContext#
â–¸ Const useBearerAuthContext<FetcherConfig>(): BearerAuthContextData<FetcherConfig>
Type parameters#
| Name | Type |
|---|---|
FetcherConfig | extends Tokens |
Returns#
BearerAuthContextData<FetcherConfig>
useBearerAuthWrapper#
â–¸ useBearerAuthWrapper<FetchConfig, Data, Args>(fetcher): (args: Args) => Promise<Data>
Type parameters#
| Name |
|---|
FetchConfig |
Data |
Args |
Parameters#
| Name | Type |
|---|---|
fetcher | Fetcher<FetchConfig, Data, Args> |
Returns#
fn
â–¸ (args): Promise<Data>
Parameters#
| Name | Type |
|---|---|
args | Args |
Returns#
Promise<Data>
useBearerToken#
â–¸ useBearerToken(): string | undefined
Returns#
string | undefined
useRefreshToken#
â–¸ useRefreshToken(): string | undefined
Returns#
string | undefined
useRefreshFailureHandler#
â–¸ useRefreshFailureHandler(handler): void
Parameters#
| Name | Type |
|---|---|
handler | RefreshFailureHandler |
Returns#
void
useRefreshSuccessHandler#
â–¸ useRefreshSuccessHandler(handler): void
Parameters#
| Name | Type |
|---|---|
handler | RefreshSuccessHandler |
Returns#
void