UNPKG

use-form-auto-save

Version:

A customizable React hook for automatically saving and restoring form data with support for localStorage, sessionStorage, and external APIs.

19 lines (18 loc) 952 B
import type { SaveFunction, ErrorCallback, StorageType } from './types'; export declare function useSaveHandler({ formKey, storageType, saveFunction, onError, maxRetries, logDebug, retryCount, setRetryCount, setShouldRetry, setIsAutoSavePaused, setIsSaving, setIsSaveSuccessful, setLastSavedData, }: { formKey: string; storageType: StorageType; saveFunction?: SaveFunction; onError?: ErrorCallback; maxRetries: number; logDebug: (...args: any[]) => void; retryCount: number; setRetryCount: React.Dispatch<React.SetStateAction<number>>; setShouldRetry: React.Dispatch<React.SetStateAction<boolean>>; setIsAutoSavePaused: React.Dispatch<React.SetStateAction<boolean>>; setIsSaving: React.Dispatch<React.SetStateAction<boolean>>; setIsSaveSuccessful: React.Dispatch<React.SetStateAction<boolean>>; setLastSavedData: (data: object) => void; }): { performSave: (formData: object) => Promise<void>; };