Open History to see the last commit
1---
2id: FieldApi
3title: FieldApi
4---
5β
6# Class: FieldApi\<TParentData, TName, TFieldValidator, TFormValidator, TData\>
7β
8A class representing the API for managing a form field.
9β
10Normally, you will not need to create a new `FieldApi` instance directly.
11Instead, you will use a framework hook/function like `useField` or `createField`
12to create a new instance for you that uses your framework's reactivity model.
13However, if you need to create a new instance manually, you can do so by calling
14the `new FieldApi` constructor.
15β
16## Type Parameters
17β
18β’ **TParentData**
19β
20β’ **TName** *extends* [`DeepKeys`](../type-aliases/deepkeys.md)\<`TParentData`\>
21β
22β’ **TFieldValidator** *extends* `Validator`\<[`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined`
23β
24β’ **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined`
25β
26β’ **TData** *extends* [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\> = [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\>
27β
28## Constructors
29β
30### new FieldApi()
31β
32```ts
33new FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData>(opts): FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData>
34```
35β
36Initializes a new `FieldApi` instance.
37β
38#### Parameters
39β
40##### opts
41β
42[`FieldApiOptions`](../interfaces/fieldapioptions.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>
43β
44#### Returns
45β
46[`FieldApi`](fieldapi.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>
47β
48#### Defined in
49β
50[packages/form-core/src/FieldApi.ts:477](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L477)
51β
52## Properties
53β
54### form
55β
56```ts
57form: FormApi<TParentData, TFormValidator>;
58```
59β
60A reference to the form API instance.
61β
62#### Defined in
63β
64[packages/form-core/src/FieldApi.ts:441](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L441)
65β
66***
67β
68### name
69β
70```ts
71name: unknown extends TParentData ? string : TParentData extends readonly any[] & IsTuple<TParentData> ? PrefixTupleAccessor<TParentData<TParentData>, AllowedIndexes<TParentData<TParentData>, never>, []> : TParentData extends any[] ? PrefixArrayAccessor<TParentData<TParentData>, [any]> : TParentData extends Date ? never : TParentData extends object ? PrefixObjectAccessor<TParentData<TParentData>, []> : TParentData extends string | number | bigint | boolean ? "" : never;
72```
73β
74The field name.
75β
76#### Defined in
77β
78[packages/form-core/src/FieldApi.ts:451](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L451)
79β
80***
81β
82### options
83β
84```ts
85options: FieldApiOptions<TParentData, TName, TFieldValidator, TFormValidator, TData>;
86```
87β
88The field options.
89β
90#### Defined in
91β
92[packages/form-core/src/FieldApi.ts:455](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L455)
93β
94***
95β
96### store
97β
98```ts
99store: Derived<FieldState<TData>, readonly any[]>;
100```
101β
102The field state store.
103β
104#### Defined in
105β
106[packages/form-core/src/FieldApi.ts:465](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L465)
107β
108***
109β
110### timeoutIds
111β
112```ts
113timeoutIds: Record<ValidationCause, null | Timeout>;
114```
115β
116#### Defined in
117β
118[packages/form-core/src/FieldApi.ts:472](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L472)
119β
120## Accessors
121β
122### state
123β
124#### Get Signature
125β
126```ts
127get state(): FieldState<TData>
128```
129β
130The current field state.
131β
132##### Returns
133β
134[`FieldState`](../type-aliases/fieldstate.md)\<`TData`\>
135β
136#### Defined in
137β
138[packages/form-core/src/FieldApi.ts:469](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L469)
139β
140## Methods
141β
142### getInfo()
143β
144```ts
145getInfo(): FieldInfo<TParentData, TFormValidator>
146```
147β
148Gets the field information object.
149β
150#### Returns
151β
152[`FieldInfo`](../type-aliases/fieldinfo.md)\<`TParentData`, `TFormValidator`\>
153β
154#### Defined in
155β
156[packages/form-core/src/FieldApi.ts:672](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L672)
157β
158***
159β
160### getMeta()
161β
162```ts
163getMeta(): FieldMeta
164```
165β
166#### Returns
167β
168[`FieldMeta`](../type-aliases/fieldmeta.md)
169β
170#### Defined in
171β
172[packages/form-core/src/FieldApi.ts:661](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L661)
173β
174***
175β
176### ~~getValue()~~
177β
178```ts
179getValue(): TData
180```
181β
182Gets the current field value.
183β
184#### Returns
185β
186`TData`
187β
188#### Deprecated
189β
190Use `field.state.value` instead.
191β
192#### Defined in
193β
194[packages/form-core/src/FieldApi.ts:643](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L643)
195β
196***
197β
198### handleBlur()
199β
200```ts
201handleBlur(): void
202```
203β
204Handles the blur event.
205β
206#### Returns
207β
208`void`
209β
210#### Defined in
211β
212[packages/form-core/src/FieldApi.ts:1024](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1024)
213β
214***
215β
216### handleChange()
217β
218```ts
219handleChange(updater): void
220```
221β
222Handles the change event.
223β
224#### Parameters
225β
226##### updater
227β
228[`Updater`](../type-aliases/updater.md)\<`TData`\>
229β
230#### Returns
231β
232`void`
233β
234#### Defined in
235β
236[packages/form-core/src/FieldApi.ts:1017](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1017)
237β
238***
239β
240### insertValue()
241β
242```ts
243insertValue(
244 index,
245 value,
246opts?): Promise<void>
247```
248β
249Inserts a value at the specified index, shifting the subsequent values to the right.
250β
251#### Parameters
252β
253##### index
254β
255`number`
256β
257##### value
258β
259`TData` *extends* `any`[] ? `TData`\<`TData`\>\[`number`\] : `never`
260β
261##### opts?
262β
263`UpdateMetaOptions`
264β
265#### Returns
266β
267`Promise`\<`void`\>
268β
269#### Defined in
270β
271[packages/form-core/src/FieldApi.ts:685](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L685)
272β
273***
274β
275### mount()
276β
277```ts
278mount(): () => void
279```
280β
281Mounts the field instance to the form.
282β
283#### Returns
284β
285`Function`
286β
287##### Returns
288β
289`void`
290β
291#### Defined in
292β
293[packages/form-core/src/FieldApi.ts:567](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L567)
294β
295***
296β
297### moveValue()
298β
299```ts
300moveValue(
301 aIndex,
302 bIndex,
303 opts?): void
304```
305β
306Moves the value at the first specified index to the second specified index.
307β
308#### Parameters
309β
310##### aIndex
311β
312`number`
313β
314##### bIndex
315β
316`number`
317β
318##### opts?
319β
320`UpdateMetaOptions`
321β
322#### Returns
323β
324`void`
325β
326#### Defined in
327β
328[packages/form-core/src/FieldApi.ts:715](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L715)
329β
330***
331β
332### pushValue()
333β
334```ts
335pushValue(value, opts?): void
336```
337β
338Pushes a new value to the field.
339β
340#### Parameters
341β
342##### value
343β
344`TData` *extends* `any`[] ? `TData`\<`TData`\>\[`number`\] : `never`
345β
346##### opts?
347β
348`UpdateMetaOptions`
349β
350#### Returns
351β
352`void`
353β
354#### Defined in
355β
356[packages/form-core/src/FieldApi.ts:677](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L677)
357β
358***
359β
360### removeValue()
361β
362```ts
363removeValue(index, opts?): Promise<void>
364```
365β
366Removes a value at the specified index.
367β
368#### Parameters
369β
370##### index
371β
372`number`
373β
374##### opts?
375β
376`UpdateMetaOptions`
377β
378#### Returns
379β
380`Promise`\<`void`\>
381β
382#### Defined in
383β
384[packages/form-core/src/FieldApi.ts:703](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L703)
385β
386***
387β
388### replaceValue()
389β
390```ts
391replaceValue(
392 index,
393 value,
394opts?): Promise<void>
395```
396β
397Replaces a value at the specified index.
398β
399#### Parameters
400β
401##### index
402β
403`number`
404β
405##### value
406β
407`TData` *extends* `any`[] ? `TData`\<`TData`\>\[`number`\] : `never`
408β
409##### opts?
410β
411`UpdateMetaOptions`
412β
413#### Returns
414β
415`Promise`\<`void`\>
416β
417#### Defined in
418β
419[packages/form-core/src/FieldApi.ts:694](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L694)
420β
421***
422β
423### setErrorMap()
424β
425```ts
426setErrorMap(errorMap): void
427```
428β
429Updates the field's errorMap
430β
431#### Parameters
432β
433##### errorMap
434β
435`ValidationErrorMap`
436β
437#### Returns
438β
439`void`
440β
441#### Defined in
442β
443[packages/form-core/src/FieldApi.ts:1044](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1044)
444β
445***
446β
447### setMeta()
448β
449```ts
450setMeta(updater): void
451```
452β
453Sets the field metadata.
454β
455#### Parameters
456β
457##### updater
458β
459[`Updater`](../type-aliases/updater.md)\<[`FieldMeta`](../type-aliases/fieldmeta.md)\>
460β
461#### Returns
462β
463`void`
464β
465#### Defined in
466β
467[packages/form-core/src/FieldApi.ts:666](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L666)
468β
469***
470β
471### setValue()
472β
473```ts
474setValue(updater, options?): void
475```
476β
477Sets the field value and run the `change` validator.
478β
479#### Parameters
480β
481##### updater
482β
483[`Updater`](../type-aliases/updater.md)\<`TData`\>
484β
485##### options?
486β
487`UpdateMetaOptions`
488β
489#### Returns
490β
491`void`
492β
493#### Defined in
494β
495[packages/form-core/src/FieldApi.ts:650](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L650)
496β
497***
498β
499### swapValues()
500β
501```ts
502swapValues(
503 aIndex,
504 bIndex,
505 opts?): void
506```
507β
508Swaps the values at the specified indices.
509β
510#### Parameters
511β
512##### aIndex
513β
514`number`
515β
516##### bIndex
517β
518`number`
519β
520##### opts?
521β
522`UpdateMetaOptions`
523β
524#### Returns
525β
526`void`
527β
528#### Defined in
529β
530[packages/form-core/src/FieldApi.ts:709](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L709)
531β
532***
533β
534### update()
535β
536```ts
537update(opts): void
538```
539β
540Updates the field instance with new options.
541β
542#### Parameters
543β
544##### opts
545β
546[`FieldApiOptions`](../interfaces/fieldapioptions.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>
547β
548#### Returns
549β
550`void`
551β
552#### Defined in
553β
554[packages/form-core/src/FieldApi.ts:606](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L606)
555β
556***
557β
558### validate()
559β
560```ts
561validate(cause): ValidationError[] | Promise<ValidationError[]>
562```
563β
564Validates the field value.
565β
566#### Parameters
567β
568##### cause
569β
570`ValidationCause`
571β
572#### Returns
573β
574[`ValidationError`](../type-aliases/validationerror.md)[] \| `Promise`\<[`ValidationError`](../type-aliases/validationerror.md)[]\>
575β
576#### Defined in
577β
578[packages/form-core/src/FieldApi.ts:989](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L989)