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

FieldInfo.md

40 lines892 Bytes

1---
2id: FieldInfo
3title: FieldInfo
4---
5​
6# Type Alias: FieldInfo\<TFormData, TFormValidator\>
7​
8```ts
9type FieldInfo<TFormData, TFormValidator>: object;
10```
11​
12An object representing the field information for a specific field within the form.
13​
14## Type Parameters
15​
16β€’ **TFormData**
17​
18β€’ **TFormValidator** *extends* `Validator`\<`TFormData`, `unknown`\> \| `undefined` = `undefined`
19​
20## Type declaration
21​
22### instance
23​
24```ts
25instance: FieldApi<TFormData, any, Validator<unknown, unknown> | undefined, TFormValidator> | null;
26```
27​
28An instance of the FieldAPI.
29​
30### validationMetaMap
31​
32```ts
33validationMetaMap: Record<ValidationErrorMapKeys, ValidationMeta | undefined>;
34```
35​
36A record of field validation internal handling.
37​
38## Defined in
39​
40[packages/form-core/src/FormApi.ts:176](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L176)