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

Nhost React library

import { SignInEmailPasswordHandlerResult, SignInEmailPasswordState, SignInMfaTotpHandlerResult } from '@nhost/nhost-js';

interface SignInEmailPasswordHandler {
    (email: string, password: string): Promise<SignInEmailPasswordHandlerResult>;
}
export interface SendMfaOtpHandler {
    (otp: string): Promise<SignInMfaTotpHandlerResult>;
}
export interface SignInEmailPasswordHookResult extends SignInEmailPasswordState {
    signInEmailPassword: SignInEmailPasswordHandler;
    sendMfaOtp: SendMfaOtpHandler;
}
interface SignInEmailPasswordHook {
    (): SignInEmailPasswordHookResult;
}
/**
 * Use the hook `useSignInEmailPassword` to sign in a user using email and password.
 *
 * @example
 * ```tsx
 * const { signInEmailPassword, needsEmailVerification, isLoading, isSuccess, isError, error } = useSignInEmailPassword()
 *
 * console.log({ needsEmailVerification, isLoading, isSuccess, isError, error });
 *
 * const handleFormSubmit = async (e) => {
 *   e.preventDefault();
 *
 *   await signInEmailPassword('joe@example.com','secret-password')
 * }
 * ```
 *
 * @docs https://docs.nhost.io/reference/react/use-sign-in-email-password
 */
export declare const useSignInEmailPassword: SignInEmailPasswordHook;
export {};
//# sourceMappingURL=useSignInEmailPassword.d.ts.map