@modular-forms/react/dist/types/utils/getPathValue.d.ts

The modular and type-safe form library for React

import type { FieldArrayPath, FieldArrayPathValue, FieldPath, FieldPathValue, FieldValues, Maybe, PartialValues } from '../types';
/**
 * Returns the value of a dot path in an object.
 *
 * @param path The dot path.
 * @param object The object.
 *
 * @returns The value or undefined.
 */
export declare function getPathValue<TFieldValues extends FieldValues, TFieldName extends FieldPath<TFieldValues>>(path: TFieldName, object: PartialValues<TFieldValues>): Maybe<FieldPathValue<TFieldValues, TFieldName>>;
/**
 * Returns the value of a dot path in an object.
 *
 * @param path The dot path.
 * @param object The object.
 *
 * @returns The value or undefined.
 */
export declare function getPathValue<TFieldValues extends FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues>>(path: TFieldArrayName, object: PartialValues<TFieldValues>): Maybe<FieldArrayPathValue<TFieldValues, TFieldArrayName>>;