getDeepErrorEntry
Retrieves the errors of the first erroring field of a specific field or the entire form as an entry pairing the path to the field with its error messages, by walking through the field store and all its descendants and stopping at the first field with errors. This is useful for locating the first erroring descendant of a field whose value is a nested structure while retaining all errors at that path.
const entry = getDeepErrorEntry<TSchema>(form);
const entry = getDeepErrorEntry<TSchema, TFieldPath>(form, config);Generics
TSchemaextends FormSchemaTFieldPathextends RequiredPath | undefined = undefined
Parameters
formBaseFormStore<TSchema>configGetFormDeepErrorEntryConfig | GetFieldDeepErrorEntryConfig<TSchema, TFieldPath> | undefined
Explanation
The form parameter is the form store to retrieve the error entry from. The optional config parameter scopes the search to a specific field's subtree via a path (when omitted, the entire form is walked). The function walks through the field store and all its descendants in depth-first order and stops at the first field with errors, so errors of a field surface before errors of its descendants. The returned entry contains the path to the field and its non-empty list of errors. Form-level errors are included with an empty path.
Returns
resultDeepErrorEntry<v.InferInput<TSchema>> | null