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

FieldValidationPredicateContext.md

108 lines2.0 KB

1---
2id: FieldValidationPredicateContext
3title: FieldValidationPredicateContext
4---
5​
6Defined in: [validation.public.ts:443](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L443)
7​
8Current field state available to validator conditions and delay callbacks.
9​
10## Extends
11​
12- `BaseValidationPredicateContext`\<`TFormData`, `TFieldValue`, `"field"`\>
13​
14## Type Parameters
15​
16### TFormData
17​
18`TFormData`
19​
20Library-managed. Do not specify explicitly.
21​
22### TFieldValue
23​
24`TFieldValue`
25​
26Library-managed. Do not specify explicitly.
27​
28## Properties
29​
30### fieldApi
31​
32```ts
33fieldApi: AnyFieldApi;
34```
35​
36Defined in: [validation.public.ts:449](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L449)
37​
38The field being validated.
39​
40#### Overrides
41​
42```ts
43BaseValidationPredicateContext.fieldApi
44```
45​
46***
47​
48### formApi
49​
50```ts
51formApi: FormApi<TFormData, any>;
52```
53​
54Defined in: [validation.public.ts:402](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L402)
55​
56The owning form, including its complete values and state.
57​
58#### Inherited from
59​
60```ts
61BaseValidationPredicateContext.formApi
62```
63​
64***
65​
66### groupApi?
67​
68```ts
69optional groupApi?: undefined;
70```
71​
72Defined in: [validation.public.ts:447](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L447)
73​
74***
75​
76### scope
77​
78```ts
79scope: "field";
80```
81​
82Defined in: [validation.public.ts:400](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L400)
83​
84Identifies whether `value` belongs to a form, form group, or field.
85​
86#### Inherited from
87​
88```ts
89BaseValidationPredicateContext.scope
90```
91​
92***
93​
94### value
95​
96```ts
97value: TFieldValue;
98```
99​
100Defined in: [validation.public.ts:411](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L411)
101​
102The current value in this validator's scope when the callback is evaluated.
103​
104#### Inherited from
105​
106```ts
107BaseValidationPredicateContext.value
108```