Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

FormValidator.md

145 lines3.2 KB

1---
2id: FormValidator
3title: FormValidator
4---
5​
6Defined in: [validation.public.ts:816](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L816)
7​
8Configures validation of complete form values on the client or server.
9​
10## Extends
11​
12- [`BaseValidator`](BaseValidator.md)\<
13 \| [`FormValidatorFn`](../type-aliases/FormValidatorFn.md)\<`TFormData`\>
14 \| [`StandardSchemaV1`](../type-aliases/StandardSchemaV1.md)\<`TFormData`, `any`\>\>
15​
16## Type Parameters
17​
18### TFormData
19​
20`TFormData`
21​
22Library-managed. Do not specify explicitly.
23​
24## Properties
25​
26### bailIfInvalid?
27​
28```ts
29optional bailIfInvalid?: boolean;
30```
31​
32Defined in: [validation.public.ts:29](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L29)
33​
34If `true`, skips this and subsequent validators when earlier validation has failed.
35​
36If `false`, earlier failures do not prevent this validator from running.
37​
38#### Default
39​
40```ts
41false
42```
43​
44#### Inherited from
45​
46[`BaseValidator`](BaseValidator.md).[`bailIfInvalid`](BaseValidator.md#bailifinvalid)
47​
48***
49​
50### run
51​
52```ts
53run:
54 | FormValidatorFn<TFormData>
55| StandardSchemaV1<TFormData, any>;
56```
57​
58Defined in: [validation.public.ts:21](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L21)
59​
60The function or Standard Schema that validates the value in this validator's scope.
61​
62#### Inherited from
63​
64[`BaseValidator`](BaseValidator.md).[`run`](BaseValidator.md#run)
65​
66***
67​
68### runOnMount?
69​
70```ts
71optional runOnMount?: boolean;
72```
73​
74Defined in: [validation.public.ts:833](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L833)
75​
76Whether this validator runs when the form is constructed.
77​
78#### Default
79​
80```ts
81false
82```
83​
84***
85​
86### skipOnSubmit?
87​
88```ts
89optional skipOnSubmit?:
90 | boolean
91| ValidationPredicateFn<TFormData, TFormData, "form">;
92```
93​
94Defined in: [validation.public.ts:827](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L827)
95​
96Whether this validator runs during a client submission attempt, independently of `triggers`.
97​
98Pass a boolean or a function that returns
99`true` to skip it for the current attempt.
100​
101#### Default
102​
103```ts
104false
105```
106​
107***
108​
109### triggerDebounceMs?
110​
111```ts
112optional triggerDebounceMs?:
113 | number
114| ValidationDebounceFn<TFormData, TFormData, "form">;
115```
116​
117Defined in: [validation.public.ts:843](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L843)
118​
119The delay in milliseconds before validation runs for change or blur events.
120​
121Pass a number for a fixed delay, or pass a function that returns the delay
122for the current event. Repeated events restart the delay.
123Submission and server validation run immediately.
124​
125#### Default
126​
127```ts
129```
130​
131***
132​
133### triggers
134​
135```ts
136triggers: FormValidationTriggerOption<TFormData, TFormData, "form">[];
137```
138​
139Defined in: [validation.public.ts:852](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L852)
140​
141Change and blur events that can run this validator, optionally with conditions.
142Add `'server'` to include it in `serverValidate`.
143​
144An empty array disables change, blur, and server validation. Configure client
145submission separately with `skipOnSubmit` and initial validation with `runOnMount`.