import { FieldPath, FormMode, PathsAndValues, PathsOrValues, UseFormStateHook, Values } from './useFormState'; import { RefObject } from 'react'; import { UseFormKeysHook } from './useFormKeys'; import { UseFormStatusHook } from './useFormStatus'; import { Observer } from '@jalik/observer'; import { UseFormErrorsHook } from './useFormErrors'; export type ClearValuesOptions = { forceUpdate?: boolean; initialize?: boolean; }; export type SetValuesOptions = { applyTransform?: boolean; forceUpdate?: boolean; initialize?: boolean; nullify?: boolean; partial?: boolean; updateErrors?: boolean; updateModified?: boolean; updateTouched?: boolean; validate?: boolean; }; export type SetValueOptions = Pick; export type UseFormValuesOptions = { /** * Update the form when it is modified or touched (happens only at the form level). */ forceUpdateOnStatusChange?: boolean; /** * The form keys hook. */ formKeys: UseFormKeysHook; /** * The form errors hook. */ formErrors: UseFormErrorsHook; /** * The form state hook. */ formState: UseFormStateHook; /** * The form keys hook. */ formStatus: UseFormStatusHook; /** * The form mode. */ mode: FormMode; /** * Replaces empty string by null when setting values. */ nullify?: boolean; /** * Executes a callback when values changed. * @param values */ onValuesChange?: (values: V, previousValues: V) => void; /** * Resets values with initial values when they change. */ reinitialize?: boolean; /** * Returns transformed values. * @param mutation * @param values */ transform?(mutation: PathsAndValues, values: V): PathsAndValues; /** * Registered watchers. */ watchers: RefObject>; }; export type UseFormValuesHook = { /** * Clears all values (set to undefined) or for given paths. * @param paths * @param options */ clearValues(paths?: FieldPath[], options?: ClearValuesOptions): void; /** * Returns the initial value of a field. */ getInitialValue

>(path: FieldPath, defaultValue?: V[P]): V[P] | undefined; /** * Returns the initial values. */ getInitialValues(): V | undefined; /** * Returns a value. */ getValue

>(path: P, defaultValue?: V[P]): V[P] | undefined; /** * Returns values. */ getValues(): V; /** * Initialize form with values. * @param values * @param options */ initialize(values: V, options?: { forceUpdate?: boolean; }): void; /** * Removes existing values (set to undefined). * @param paths * @param options */ removeValues(paths: FieldPath[], options?: { forceUpdate?: boolean; }): void; /** * Restores all initial values or for given paths. * @param paths * @param options */ resetValues(paths?: FieldPath[], options?: { forceUpdate?: boolean; }): void; /** * Sets or replaces initial values. * @param values * @param options */ setInitialValues(values: PathsOrValues, options?: { partial?: boolean; }): void; /** * Sets a single value. * @param path * @param value * @param options */ setValue

>(path: P, value: V[P], options?: SetValueOptions): void; /** * Sets given values of all values. * @param values * @param options */ setValues(values: PathsOrValues, options?: SetValuesOptions): void; }; declare function useFormValues(options: UseFormValuesOptions): UseFormValuesHook; export default useFormValues; //# sourceMappingURL=useFormValues.d.ts.map