getDeepErrorEntries

Retrieves the errors of a specific field or the entire form as a list of entries, each pairing the path to a field with its error messages. This is useful for building custom error summaries that link each message back to its field.

const entries = getDeepErrorEntries<TSchema>(form);
const entries = getDeepErrorEntries<TSchema, TFieldPath>(form, config);

Generics

• TSchema extends FormSchema
• TFieldPath extends RequiredPath | undefined = undefined

Parameters

• form BaseFormStore<TSchema>
• config GetFormDeepErrorEntriesConfig | GetFieldDeepErrorEntriesConfig<TSchema, TFieldPath> | undefined

Explanation

The form parameter is the form store to retrieve error entries from. The optional config parameter scopes the collection to a specific field's subtree via a path (when omitted, the entire form is walked). Each returned entry contains the path to a field and its non-empty list of errors.

Returns

• result DeepErrorEntry[]

Related

Primitives

• useForm

Methods

• getErrors,
• getDeepErrors,
• validate