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

FieldMeta.md

66 lines1.0 KB

1---
2id: FieldMeta
3title: FieldMeta
4---
5​
6# Type Alias: FieldMeta
7​
8```ts
9type FieldMeta: object;
10```
11​
12An object type representing the metadata of a field in a form.
13​
14## Type declaration
15​
16### errorMap
17​
18```ts
19errorMap: ValidationErrorMap;
20```
21​
22A map of errors related to the field value.
23​
24### errors
25​
26```ts
27errors: ValidationError[];
28```
29​
30An array of errors related to the field value.
31​
32### isDirty
33​
34```ts
35isDirty: boolean;
36```
37​
38A flag that is `true` if the field's value has been modified by the user. Opposite of `isPristine`.
39​
40### isPristine
41​
42```ts
43isPristine: boolean;
44```
45​
46A flag that is `true` if the field's value has not been modified by the user. Opposite of `isDirty`.
47​
48### isTouched
49​
50```ts
51isTouched: boolean;
52```
53​
54A flag indicating whether the field has been touched.
55​
56### isValidating
57​
58```ts
59isValidating: boolean;
60```
61​
62A flag indicating whether the field is currently being validated.
63​
64## Defined in
65​
66[packages/form-core/src/FieldApi.ts:331](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L331)