react-hook-form-storage/dist/types.d.ts

A TypeScript library for React Hook Form persist functionality

import type { FieldValues, Path } from 'react-hook-form';
export type Serializer<T, K extends keyof T> = {
    serialize?: (value: T[K]) => any;
    deserialize?: (value: any) => T[K];
};
export type UseFormStorageAdapter = {
    getItem: (key: string) => Promise<string | null>;
    setItem: (key: string, value: string) => Promise<void>;
    removeItem: (key: string) => Promise<void>;
};
type UseFormStorageBaseOptions<T extends FieldValues> = {
    storage?: Storage | UseFormStorageAdapter;
    onRestore?: (values: Record<string, any>) => void;
    onSave?: (values: Record<string, any>) => void;
    debounce?: number;
    validate?: boolean;
    dirty?: boolean;
    touched?: boolean;
    serializer?: {
        [P in Path<T>]?: Serializer<T, P>;
    };
    autoSave?: boolean;
};
type IncludedOptions<T extends FieldValues, K extends Path<T>[]> = {
    included: K;
    excluded?: any;
};
type ExcludedOptions<T extends FieldValues, K extends Path<T>[]> = {
    excluded: K;
    included?: any;
};
type NoInclusionExclusionOptions = {
    included?: undefined;
    excluded?: undefined;
};
export type UseFormStorageOptions<T extends FieldValues> = UseFormStorageBaseOptions<T> & (IncludedOptions<T, Path<T>[]> | ExcludedOptions<T, Path<T>[]> | NoInclusionExclusionOptions);
export {};