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

FieldValidationPredicateContext.md

96 lines1.6 KB

1---
2id: FieldValidationPredicateContext
3title: FieldValidationPredicateContext
4---
5​
6Defined in: [validation.public.ts:298](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L298)
7​
8## Extends
9​
10- `BaseValidationPredicateContext`\<`TFormData`, `TFieldValue`, `"field"`\>
11​
12## Type Parameters
13​
14### TFormData
15​
16`TFormData`
17​
18### TFieldValue
19​
20`TFieldValue`
21​
22## Properties
23​
24### fieldApi
25​
26```ts
27fieldApi: AnyFieldApi;
28```
29​
30Defined in: [validation.public.ts:304](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L304)
31​
32The field being validated.
33​
34#### Overrides
35​
36```ts
37BaseValidationPredicateContext.fieldApi
38```
39​
40***
41​
42### formApi
43​
44```ts
45formApi: FormApi<TFormData, any>;
46```
47​
48Defined in: [validation.public.ts:275](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L275)
49​
50#### Inherited from
51​
52```ts
53BaseValidationPredicateContext.formApi
54```
55​
56***
57​
58### groupApi?
59​
60```ts
61optional groupApi?: undefined;
62```
63​
64Defined in: [validation.public.ts:302](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L302)
65​
66***
67​
68### scope
69​
70```ts
71scope: "field";
72```
73​
74Defined in: [validation.public.ts:274](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L274)
75​
76#### Inherited from
77​
78```ts
79BaseValidationPredicateContext.scope
80```
81​
82***
83​
84### value
85​
86```ts
87value: TFieldValue;
88```
89​
90Defined in: [validation.public.ts:283](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L283)
91​
92#### Inherited from
93​
94```ts
95BaseValidationPredicateContext.value
96```