@nhost/react/dist/useSignInPAT.d.ts

Nhost React library

import { SignInPATHandlerResult, SignInPATState } from '@nhost/nhost-js';

interface SignInPATHandler {
    (pat: string): Promise<SignInPATHandlerResult>;
}
export interface SignInPATHookResult extends SignInPATState {
    signInPAT: SignInPATHandler;
}
interface SignInPATHook {
    (): SignInPATHookResult;
}
/**
 * Use the hook `useSignInPAT` to sign in a user using a personal access token.
 *
 * @example
 * ```tsx
 * const { signInPAT, isLoading, isSuccess, isError, error } = useSignInPAT()
 *
 * console.log({ isLoading, isSuccess, isError, error });
 *
 * const handleFormSubmit = async (e) => {
 *   e.preventDefault();
 *
 *   await signInPAT('8c5402d1-b05d-4825-a3ae-52d26402b89b')
 * }
 * ```
 *
 * @docs https://docs.nhost.io/reference/react/use-sign-in-pat
 */
export declare const useSignInPAT: SignInPATHook;
export {};
//# sourceMappingURL=useSignInPAT.d.ts.map