@refinedev/core
Version:
Refine is a React meta-framework for building enterprise-level, data-intensive applications rapidly with support for modern UI libraries and headless integrations.
17 lines • 1.13 kB
text/typescript
import { type UseMutationOptions, type UseMutationResult } from "@tanstack/react-query";
import type { AuthActionResponse, TForgotPasswordData } from "../../../contexts/auth/types";
import type { RefineError } from "../../../contexts/data/types";
export type UseForgotPasswordProps<TVariables> = {
mutationOptions?: Omit<UseMutationOptions<AuthActionResponse | TForgotPasswordData, Error | RefineError, TVariables, unknown>, "mutationFn">;
};
export type UseForgotPasswordReturnType<TVariables> = UseMutationResult<AuthActionResponse, Error | RefineError, TVariables, unknown>;
/**
* `useForgotPassword` calls `forgotPassword` method from {@link https://refine.dev/docs/api-reference/core/providers/auth-provider `authProvider`} under the hood.
*
* @see {@link https://refine.dev/docs/api-reference/core/hooks/auth/useForgotPassword} for more details.
*
* @typeParam TVariables - Values for mutation function. default `{}`
*
*/
export declare function useForgotPassword<TVariables = {}>({ mutationOptions, }?: UseForgotPasswordProps<TVariables>): UseForgotPasswordReturnType<TVariables>;
//# sourceMappingURL=index.d.ts.map