@authx-rs/sdk-react

Generated from packages/authx-sdk-react/dist/types.

React provider and hooks for authx token clients.

Modules

• index

index

AuthxTokenProviderProps

export interface AuthxTokenProviderProps {
    client: AuthxTokenManager;
    children?: ReactNode;
}

AuthxReactContextValue

export interface AuthxReactContextValue {
    client: AuthxTokenManager;
    snapshot: AuthxTokenSnapshot;
    accessToken: string | null;
    isAuthenticated: boolean;
    refresh(): Promise<StoredTokenState>;
    clear(): Promise<AuthxTokenSnapshot>;
    setTokens(tokens: StoredTokenState | null): Promise<AuthxTokenSnapshot>;
    setTokenResponse(response: OidcTokenResponse, options?: {
        now?: number;
        preserveRefreshToken?: boolean;
    }): Promise<AuthxTokenSnapshot>;
    fetch(input: RequestInfo | URL, init?: RequestInit, options?: AuthxFetchOptions): Promise<Response>;
}

AuthxTokenProvider

export declare function AuthxTokenProvider(props: AuthxTokenProviderProps): ReactElement;

useAuthxToken

export declare function useAuthxToken(): AuthxReactContextValue;

useAuthxSnapshot

export declare function useAuthxSnapshot(): AuthxTokenSnapshot;

useAccessToken

export declare function useAccessToken(): string | null;

useIsAuthenticated

export declare function useIsAuthenticated(): boolean;

useAuthenticatedFetch

export declare function useAuthenticatedFetch(): (input: RequestInfo | URL, init?: RequestInit, options?: AuthxFetchOptions) => Promise<Response>;