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

ValidationLogicProps.md

101 lines1.9 KB

1---
2id: ValidationLogicProps
3title: ValidationLogicProps
4---
5​
6# Interface: ValidationLogicProps
7​
8Defined in: [packages/form-core/src/ValidationLogic.ts:21](https://github.com/TanStack/form/blob/main/packages/form-core/src/ValidationLogic.ts#L21)
9​
10## Properties
11​
12### event
13​
14```ts
15event: object;
16```
17​
18Defined in: [packages/form-core/src/ValidationLogic.ts:35](https://github.com/TanStack/form/blob/main/packages/form-core/src/ValidationLogic.ts#L35)
19​
20#### async
21​
22```ts
23async: boolean;
24```
25​
26#### fieldName?
27​
28```ts
29optional fieldName: string;
30```
31​
32#### type
33​
34```ts
35type: "change" | "blur" | "submit" | "mount" | "server";
36```
37​
38***
39​
40### form
41​
42```ts
43form: AnyFormApi;
44```
45​
46Defined in: [packages/form-core/src/ValidationLogic.ts:23](https://github.com/TanStack/form/blob/main/packages/form-core/src/ValidationLogic.ts#L23)
47​
48***
49​
50### group?
51​
52```ts
53optional group: AnyFormGroupApi;
54```
55​
56Defined in: [packages/form-core/src/ValidationLogic.ts:29](https://github.com/TanStack/form/blob/main/packages/form-core/src/ValidationLogic.ts#L29)
57​
58Set when the validators being processed belong to a `FormGroupApi`.
59Allows validation strategies (e.g. `revalidateLogic`) to gate their
60behavior on the group's own state instead of the parent form's.
61​
62***
63​
64### runValidation()
65​
66```ts
67runValidation: (props) => void;
68```
69​
70Defined in: [packages/form-core/src/ValidationLogic.ts:40](https://github.com/TanStack/form/blob/main/packages/form-core/src/ValidationLogic.ts#L40)
71​
72#### Parameters
73​
74##### props
75​
76###### form
77​
78[`AnyFormApi`](../type-aliases/AnyFormApi.md)
79​
80###### validators
81​
83 \| [`ValidationLogicValidatorsFn`](ValidationLogicValidatorsFn.md)
84 \| `undefined`)[]
85​
86#### Returns
87​
88`void`
89​
90***
91​
92### validators
93​
94```ts
95validators:
96 | FormValidators<any, any, any, any, any, any, any, any, any, any>
97 | null
98 | undefined;
99```
100​
101Defined in: [packages/form-core/src/ValidationLogic.ts:31](https://github.com/TanStack/form/blob/main/packages/form-core/src/ValidationLogic.ts#L31)