# FieldApi # Class: FieldApi\ Defined in: [packages/form-core/src/FieldApi.ts:993](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L993) A class representing the API for managing a form field. Normally, you will not need to create a new `FieldApi` instance directly. Instead, you will use a framework hook/function like `useField` or `createField` to create a new instance for you that uses your framework's reactivity model. However, if you need to create a new instance manually, you can do so by calling the `new FieldApi` constructor. ## Type Parameters ### TParentData `TParentData` ### TName `TName` *extends* [`DeepKeys`](../type-aliases/DeepKeys.md)\<`TParentData`\> ### TData `TData` *extends* [`DeepValue`](../type-aliases/DeepValue.md)\<`TParentData`, `TName`\> ### TOnMount `TOnMount` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> ### TOnChange `TOnChange` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> ### TOnChangeAsync `TOnChangeAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> ### TOnBlur `TOnBlur` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> ### TOnBlurAsync `TOnBlurAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> ### TOnSubmit `TOnSubmit` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> ### TOnSubmitAsync `TOnSubmitAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> ### TOnDynamic `TOnDynamic` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> ### TOnDynamicAsync `TOnDynamicAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> ### TFormOnMount `TFormOnMount` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> ### TFormOnChange `TFormOnChange` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> ### TFormOnChangeAsync `TFormOnChangeAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> ### TFormOnBlur `TFormOnBlur` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> ### TFormOnBlurAsync `TFormOnBlurAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> ### TFormOnSubmit `TFormOnSubmit` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> ### TFormOnSubmitAsync `TFormOnSubmitAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> ### TFormOnDynamic `TFormOnDynamic` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> ### TFormOnDynamicAsync `TFormOnDynamicAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> ### TFormOnServer `TFormOnServer` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> ### TParentSubmitMeta `TParentSubmitMeta` ## Constructors ### Constructor ```ts new FieldApi(opts): FieldApi; ``` Defined in: [packages/form-core/src/FieldApi.ts:1147](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1147) Initializes a new `FieldApi` instance. #### Parameters ##### opts [`FieldApiOptions`](../interfaces/FieldApiOptions.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TParentSubmitMeta`\> #### Returns `FieldApi`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TParentSubmitMeta`\> ## Properties ### form ```ts form: FormApi; ``` Defined in: [packages/form-core/src/FieldApi.ts:1047](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1047) A reference to the form API instance. *** ### name ```ts name: TName; ``` Defined in: [packages/form-core/src/FieldApi.ts:1075](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1075) The field name. *** ### options ```ts options: FieldApiOptions; ``` Defined in: [packages/form-core/src/FieldApi.ts:1079](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1079) The field options. *** ### store ```ts store: ReadonlyStore>; ``` Defined in: [packages/form-core/src/FieldApi.ts:1107](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1107) The field state store. *** ### timeoutIds ```ts timeoutIds: object; ``` Defined in: [packages/form-core/src/FieldApi.ts:1138](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1138) #### formListeners ```ts formListeners: Record | null>; ``` #### listeners ```ts listeners: Record | null>; ``` #### validations ```ts validations: Record | null>; ``` ## Accessors ### state #### Get Signature ```ts get state(): FieldState; ``` Defined in: [packages/form-core/src/FieldApi.ts:1135](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1135) The current field state. ##### Returns [`FieldState`](../type-aliases/FieldState.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`\> ## Methods ### clearValues() ```ts clearValues(options?): void; ``` Defined in: [packages/form-core/src/FieldApi.ts:1649](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1649) Clear all values from the array. #### Parameters ##### options? `UpdateMetaOptions` #### Returns `void` *** ### getInfo() ```ts getInfo(): FieldInfo; ``` Defined in: [packages/form-core/src/FieldApi.ts:1535](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1535) Gets the field information object. #### Returns [`FieldInfo`](../type-aliases/FieldInfo.md)\<`TParentData`\> *** ### getMeta() ```ts getMeta(): FieldMeta; ``` Defined in: [packages/form-core/src/FieldApi.ts:1499](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1499) #### Returns [`FieldMeta`](../type-aliases/FieldMeta.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`\> *** ### ~~getValue()~~ ```ts getValue(): TData; ``` Defined in: [packages/form-core/src/FieldApi.ts:1476](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1476) Gets the current field value. #### Returns `TData` #### Deprecated Use `field.state.value` instead. *** ### handleBlur() ```ts handleBlur(): void; ``` Defined in: [packages/form-core/src/FieldApi.ts:2048](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L2048) Handles the blur event. #### Returns `void` *** ### handleChange() ```ts handleChange(updater): void; ``` Defined in: [packages/form-core/src/FieldApi.ts:2041](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L2041) Handles the change event. #### Parameters ##### updater [`Updater`](../type-aliases/Updater.md)\<`TData`\> #### Returns `void` *** ### insertValue() ```ts insertValue( index, value, options?): void; ``` Defined in: [packages/form-core/src/FieldApi.ts:1558](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1558) Inserts a value at the specified index, shifting the subsequent values to the right. #### Parameters ##### index `number` ##### value `TData` *extends* `any`[] ? `TData`\<`TData`\>\[`number`\] : `never` ##### options? `UpdateMetaOptions` #### Returns `void` *** ### mount() ```ts mount(): () => void; ``` Defined in: [packages/form-core/src/FieldApi.ts:1294](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1294) Mounts the field instance to the form. #### Returns A function to unmount the field instance. ```ts (): void; ``` ##### Returns `void` *** ### moveValue() ```ts moveValue( aIndex, bIndex, options?): void; ``` Defined in: [packages/form-core/src/FieldApi.ts:1633](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1633) Moves the value at the first specified index to the second specified index. #### Parameters ##### aIndex `number` ##### bIndex `number` ##### options? `UpdateMetaOptions` #### Returns `void` *** ### parseValueWithSchema() ```ts parseValueWithSchema(schema): | StandardSchemaV1Issue[] | undefined; ``` Defined in: [packages/form-core/src/FieldApi.ts:2091](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L2091) Parses the field's value with the given schema and returns issues (if any). This method does NOT set any internal errors. #### Parameters ##### schema [`StandardSchemaV1`](../type-aliases/StandardSchemaV1.md)\<`TData`, `unknown`\> The standard schema to parse this field's value with. #### Returns \| [`StandardSchemaV1Issue`](../interfaces/StandardSchemaV1Issue.md)[] \| `undefined` *** ### parseValueWithSchemaAsync() ```ts parseValueWithSchemaAsync(schema): Promise< | StandardSchemaV1Issue[] | undefined>; ``` Defined in: [packages/form-core/src/FieldApi.ts:2103](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L2103) Parses the field's value with the given schema and returns issues (if any). This method does NOT set any internal errors. #### Parameters ##### schema [`StandardSchemaV1`](../type-aliases/StandardSchemaV1.md)\<`TData`, `unknown`\> The standard schema to parse this field's value with. #### Returns `Promise`\< \| [`StandardSchemaV1Issue`](../interfaces/StandardSchemaV1Issue.md)[] \| `undefined`\> *** ### pushValue() ```ts pushValue(value, options?): void; ``` Defined in: [packages/form-core/src/FieldApi.ts:1540](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1540) Pushes a new value to the field. #### Parameters ##### value `TData` *extends* `any`[] ? `TData`\<`TData`\>\[`number`\] : `never` ##### options? `UpdateMetaOptions` #### Returns `void` *** ### removeValue() ```ts removeValue(index, options?): void; ``` Defined in: [packages/form-core/src/FieldApi.ts:1598](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1598) Removes a value at the specified index. #### Parameters ##### index `number` ##### options? `UpdateMetaOptions` #### Returns `void` *** ### replaceValue() ```ts replaceValue( index, value, options?): void; ``` Defined in: [packages/form-core/src/FieldApi.ts:1578](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1578) Replaces a value at the specified index. #### Parameters ##### index `number` ##### value `TData` *extends* `any`[] ? `TData`\<`TData`\>\[`number`\] : `never` ##### options? `UpdateMetaOptions` #### Returns `void` *** ### setErrorMap() ```ts setErrorMap(errorMap): void; ``` Defined in: [packages/form-core/src/FieldApi.ts:2064](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L2064) Updates the field's errorMap #### Parameters ##### errorMap `ValidationErrorMap`\<[`UnwrapFieldValidateOrFn`](../type-aliases/UnwrapFieldValidateOrFn.md)\<`TName`, `TOnMount`, `TFormOnMount`\>, [`UnwrapFieldValidateOrFn`](../type-aliases/UnwrapFieldValidateOrFn.md)\<`TName`, `TOnChange`, `TFormOnChange`\>, [`UnwrapFieldAsyncValidateOrFn`](../type-aliases/UnwrapFieldAsyncValidateOrFn.md)\<`TName`, `TOnChangeAsync`, `TFormOnChangeAsync`\>, [`UnwrapFieldValidateOrFn`](../type-aliases/UnwrapFieldValidateOrFn.md)\<`TName`, `TOnBlur`, `TFormOnBlur`\>, [`UnwrapFieldAsyncValidateOrFn`](../type-aliases/UnwrapFieldAsyncValidateOrFn.md)\<`TName`, `TOnBlurAsync`, `TFormOnBlurAsync`\>, [`UnwrapFieldValidateOrFn`](../type-aliases/UnwrapFieldValidateOrFn.md)\<`TName`, `TOnSubmit`, `TFormOnSubmit`\>, [`UnwrapFieldAsyncValidateOrFn`](../type-aliases/UnwrapFieldAsyncValidateOrFn.md)\<`TName`, `TOnSubmitAsync`, `TFormOnSubmitAsync`\>, [`UnwrapFieldValidateOrFn`](../type-aliases/UnwrapFieldValidateOrFn.md)\<`TName`, `TOnDynamic`, `TFormOnDynamic`\>, [`UnwrapFieldAsyncValidateOrFn`](../type-aliases/UnwrapFieldAsyncValidateOrFn.md)\<`TName`, `TOnDynamicAsync`, `TFormOnDynamicAsync`\>\> #### Returns `void` *** ### setMeta() ```ts setMeta(updater): void; ``` Defined in: [packages/form-core/src/FieldApi.ts:1504](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1504) Sets the field metadata. #### Parameters ##### updater [`Updater`](../type-aliases/Updater.md)\<[`FieldMetaBase`](../type-aliases/FieldMetaBase.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`\>\> #### Returns `void` *** ### setValue() ```ts setValue(updater, options?): void; ``` Defined in: [packages/form-core/src/FieldApi.ts:1483](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1483) Sets the field value and run the `change` validator. #### Parameters ##### updater [`Updater`](../type-aliases/Updater.md)\<`TData`\> ##### options? `UpdateMetaOptions` #### Returns `void` *** ### swapValues() ```ts swapValues( aIndex, bIndex, options?): void; ``` Defined in: [packages/form-core/src/FieldApi.ts:1613](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1613) Swaps the values at the specified indices. #### Parameters ##### aIndex `number` ##### bIndex `number` ##### options? `UpdateMetaOptions` #### Returns `void` *** ### update() ```ts update(opts): void; ``` Defined in: [packages/form-core/src/FieldApi.ts:1425](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1425) Updates the field instance with new options. #### Parameters ##### opts [`FieldApiOptions`](../interfaces/FieldApiOptions.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TParentSubmitMeta`\> #### Returns `void` *** ### validate() ```ts validate(cause, opts?): unknown[] | Promise; ``` Defined in: [packages/form-core/src/FieldApi.ts:2008](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L2008) Validates the field value. #### Parameters ##### cause `ValidationCause` ##### opts? ###### skipFormValidation? `boolean` #### Returns `unknown`[] \| `Promise`\<`unknown`[]\>