getDeepErrors

Retrieves all error messages of a specific field or the entire form by walking through the field store and all its descendants. This is useful for displaying a summary of all validation errors within a section or the whole form.

const errors = getDeepErrors<TSchema>(form);
const errors = getDeepErrors<TSchema, TFieldPath>(form, config);

Generics

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

Parameters

• form BaseFormStore<TSchema>
• config GetFormDeepErrorsConfig | GetFieldDeepErrorsConfig<TSchema, TFieldPath> | undefined

Explanation

The form parameter is the form store to retrieve errors from. The optional config parameter scopes the collection 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 to collect every validation error message.

Returns

• result [string, ...string[]] | null

Related

Primitives

• useForm

Methods

• getErrors,
• getDeepErrorEntries,
• validate,
• setErrors