diff --git a/docs/reference/classes/fieldapi.md b/docs/reference/classes/fieldapi.md index a5cd88a21..bb9a54e30 100644 --- a/docs/reference/classes/fieldapi.md +++ b/docs/reference/classes/fieldapi.md @@ -47,7 +47,7 @@ Initializes a new `FieldApi` instance. #### Defined in -[packages/form-core/src/FieldApi.ts:513](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L513) +[packages/form-core/src/FieldApi.ts:518](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L518) ## Properties @@ -61,7 +61,7 @@ A reference to the form API instance. #### Defined in -[packages/form-core/src/FieldApi.ts:475](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L475) +[packages/form-core/src/FieldApi.ts:480](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L480) *** @@ -75,7 +75,7 @@ The field name. #### Defined in -[packages/form-core/src/FieldApi.ts:485](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L485) +[packages/form-core/src/FieldApi.ts:490](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L490) *** @@ -89,7 +89,7 @@ The field options. #### Defined in -[packages/form-core/src/FieldApi.ts:489](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L489) +[packages/form-core/src/FieldApi.ts:494](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L494) *** @@ -103,7 +103,7 @@ The current field state. #### Defined in -[packages/form-core/src/FieldApi.ts:503](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L503) +[packages/form-core/src/FieldApi.ts:508](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L508) *** @@ -117,7 +117,7 @@ The field state store. #### Defined in -[packages/form-core/src/FieldApi.ts:499](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L499) +[packages/form-core/src/FieldApi.ts:504](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L504) *** @@ -129,7 +129,7 @@ timeoutIds: Record; #### Defined in -[packages/form-core/src/FieldApi.ts:508](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L508) +[packages/form-core/src/FieldApi.ts:513](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L513) ## Methods @@ -147,7 +147,7 @@ Gets the field information object. #### Defined in -[packages/form-core/src/FieldApi.ts:752](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L752) +[packages/form-core/src/FieldApi.ts:757](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L757) *** @@ -165,7 +165,7 @@ Gets the current field metadata. #### Defined in -[packages/form-core/src/FieldApi.ts:730](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L730) +[packages/form-core/src/FieldApi.ts:735](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L735) *** @@ -187,7 +187,7 @@ Use `field.state.value` instead. #### Defined in -[packages/form-core/src/FieldApi.ts:704](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L704) +[packages/form-core/src/FieldApi.ts:709](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L709) *** @@ -205,7 +205,7 @@ Handles the blur event. #### Defined in -[packages/form-core/src/FieldApi.ts:1104](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1104) +[packages/form-core/src/FieldApi.ts:1109](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1109) *** @@ -229,7 +229,7 @@ Handles the change event. #### Defined in -[packages/form-core/src/FieldApi.ts:1097](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1097) +[packages/form-core/src/FieldApi.ts:1102](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1102) *** @@ -264,7 +264,7 @@ Inserts a value at the specified index, shifting the subsequent values to the ri #### Defined in -[packages/form-core/src/FieldApi.ts:765](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L765) +[packages/form-core/src/FieldApi.ts:770](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L770) *** @@ -286,7 +286,7 @@ Mounts the field instance to the form. #### Defined in -[packages/form-core/src/FieldApi.ts:614](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L614) +[packages/form-core/src/FieldApi.ts:619](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L619) *** @@ -321,7 +321,7 @@ Moves the value at the first specified index to the second specified index. #### Defined in -[packages/form-core/src/FieldApi.ts:795](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L795) +[packages/form-core/src/FieldApi.ts:800](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L800) *** @@ -349,7 +349,7 @@ Pushes a new value to the field. #### Defined in -[packages/form-core/src/FieldApi.ts:757](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L757) +[packages/form-core/src/FieldApi.ts:762](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L762) *** @@ -377,7 +377,7 @@ Removes a value at the specified index. #### Defined in -[packages/form-core/src/FieldApi.ts:783](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L783) +[packages/form-core/src/FieldApi.ts:788](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L788) *** @@ -412,7 +412,7 @@ Replaces a value at the specified index. #### Defined in -[packages/form-core/src/FieldApi.ts:774](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L774) +[packages/form-core/src/FieldApi.ts:779](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L779) *** @@ -436,7 +436,7 @@ Updates the field's errorMap #### Defined in -[packages/form-core/src/FieldApi.ts:1124](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1124) +[packages/form-core/src/FieldApi.ts:1129](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1129) *** @@ -460,7 +460,7 @@ Sets the field metadata. #### Defined in -[packages/form-core/src/FieldApi.ts:746](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L746) +[packages/form-core/src/FieldApi.ts:751](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L751) *** @@ -488,7 +488,7 @@ Sets the field value and run the `change` validator. #### Defined in -[packages/form-core/src/FieldApi.ts:711](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L711) +[packages/form-core/src/FieldApi.ts:716](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L716) *** @@ -523,7 +523,7 @@ Swaps the values at the specified indices. #### Defined in -[packages/form-core/src/FieldApi.ts:789](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L789) +[packages/form-core/src/FieldApi.ts:794](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L794) *** @@ -547,7 +547,7 @@ Updates the field instance with new options. #### Defined in -[packages/form-core/src/FieldApi.ts:667](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L667) +[packages/form-core/src/FieldApi.ts:672](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L672) *** @@ -571,4 +571,4 @@ Validates the field value. #### Defined in -[packages/form-core/src/FieldApi.ts:1069](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1069) +[packages/form-core/src/FieldApi.ts:1074](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1074) diff --git a/docs/reference/functions/isstandardschemavalidator.md b/docs/reference/functions/isstandardschemavalidator.md index 46f762104..725b5b58e 100644 --- a/docs/reference/functions/isstandardschemavalidator.md +++ b/docs/reference/functions/isstandardschemavalidator.md @@ -6,7 +6,7 @@ title: isStandardSchemaValidator # Function: isStandardSchemaValidator() ```ts -function isStandardSchemaValidator(validator): validator is StandardSchema +function isStandardSchemaValidator(validator): validator is StandardSchemaV1 ``` ## Parameters @@ -17,7 +17,7 @@ function isStandardSchemaValidator(validator): validator is StandardSchema` +`validator is StandardSchemaV1` ## Defined in diff --git a/docs/reference/functions/standardschemavalidator.md b/docs/reference/functions/standardschemavalidator.md index 6e6c0f910..a14609dbd 100644 --- a/docs/reference/functions/standardschemavalidator.md +++ b/docs/reference/functions/standardschemavalidator.md @@ -6,7 +6,7 @@ title: standardSchemaValidator # Function: standardSchemaValidator() ```ts -function standardSchemaValidator(params): Validator> +function standardSchemaValidator(params): Validator ``` ## Parameters @@ -17,7 +17,7 @@ function standardSchemaValidator(params): Validator\> +`Validator`\<`unknown`, `StandardSchemaV1`\> ## Defined in diff --git a/docs/reference/interfaces/fieldapioptions.md b/docs/reference/interfaces/fieldapioptions.md index 04bfa6eeb..f765f8c8c 100644 --- a/docs/reference/interfaces/fieldapioptions.md +++ b/docs/reference/interfaces/fieldapioptions.md @@ -39,7 +39,7 @@ If `true`, always run async validation, even if there are errors emitted during #### Defined in -[packages/form-core/src/FieldApi.ts:350](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L350) +[packages/form-core/src/FieldApi.ts:355](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L355) *** @@ -57,7 +57,7 @@ The default time to debounce async validation if there is not a more specific de #### Defined in -[packages/form-core/src/FieldApi.ts:346](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L346) +[packages/form-core/src/FieldApi.ts:351](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L351) *** @@ -75,7 +75,7 @@ An optional object with default metadata for the field. #### Defined in -[packages/form-core/src/FieldApi.ts:368](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L368) +[packages/form-core/src/FieldApi.ts:373](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L373) *** @@ -93,7 +93,7 @@ An optional default value for the field. #### Defined in -[packages/form-core/src/FieldApi.ts:342](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L342) +[packages/form-core/src/FieldApi.ts:347](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L347) *** @@ -105,7 +105,7 @@ form: FormApi; #### Defined in -[packages/form-core/src/FieldApi.ts:401](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L401) +[packages/form-core/src/FieldApi.ts:406](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L406) *** @@ -123,7 +123,7 @@ A list of listeners which attach to the corresponding events #### Defined in -[packages/form-core/src/FieldApi.ts:372](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L372) +[packages/form-core/src/FieldApi.ts:377](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L377) *** @@ -141,7 +141,7 @@ The field name. The type will be `DeepKeys` to ensure your name is #### Defined in -[packages/form-core/src/FieldApi.ts:338](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L338) +[packages/form-core/src/FieldApi.ts:343](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L343) *** @@ -159,7 +159,7 @@ A validator provided by an extension, like `yupValidator` from `@tanstack/yup-fo #### Defined in -[packages/form-core/src/FieldApi.ts:354](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L354) +[packages/form-core/src/FieldApi.ts:359](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L359) *** @@ -177,4 +177,4 @@ A list of validators to pass to the field #### Defined in -[packages/form-core/src/FieldApi.ts:358](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L358) +[packages/form-core/src/FieldApi.ts:363](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L363) diff --git a/docs/reference/interfaces/fieldlisteners.md b/docs/reference/interfaces/fieldlisteners.md index 713096b1d..6b6987107 100644 --- a/docs/reference/interfaces/fieldlisteners.md +++ b/docs/reference/interfaces/fieldlisteners.md @@ -27,7 +27,7 @@ optional onBlur: FieldListenerFn` to ensure your name is #### Defined in -[packages/form-core/src/FieldApi.ts:338](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L338) +[packages/form-core/src/FieldApi.ts:343](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L343) *** @@ -119,7 +119,7 @@ A validator provided by an extension, like `yupValidator` from `@tanstack/yup-fo #### Defined in -[packages/form-core/src/FieldApi.ts:354](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L354) +[packages/form-core/src/FieldApi.ts:359](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L359) *** @@ -133,4 +133,4 @@ A list of validators to pass to the field #### Defined in -[packages/form-core/src/FieldApi.ts:358](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L358) +[packages/form-core/src/FieldApi.ts:363](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L363) diff --git a/docs/reference/interfaces/fieldvalidators.md b/docs/reference/interfaces/fieldvalidators.md index 7448e6d01..22359c125 100644 --- a/docs/reference/interfaces/fieldvalidators.md +++ b/docs/reference/interfaces/fieldvalidators.md @@ -36,7 +36,7 @@ z.string().min(1) // if `zodAdapter` is passed #### Defined in -[packages/form-core/src/FieldApi.ts:221](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L221) +[packages/form-core/src/FieldApi.ts:226](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L226) *** @@ -57,7 +57,7 @@ z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' }) // #### Defined in -[packages/form-core/src/FieldApi.ts:234](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L234) +[packages/form-core/src/FieldApi.ts:239](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L239) *** @@ -73,7 +73,7 @@ If set to a number larger than 0, will debounce the async validation event by th #### Defined in -[packages/form-core/src/FieldApi.ts:247](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L247) +[packages/form-core/src/FieldApi.ts:252](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L252) *** @@ -87,7 +87,7 @@ An optional list of field names that should trigger this field's `onBlur` and `o #### Defined in -[packages/form-core/src/FieldApi.ts:251](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L251) +[packages/form-core/src/FieldApi.ts:256](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L256) *** @@ -108,7 +108,7 @@ z.string().min(1) // if `zodAdapter` is passed #### Defined in -[packages/form-core/src/FieldApi.ts:185](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L185) +[packages/form-core/src/FieldApi.ts:190](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L190) *** @@ -129,7 +129,7 @@ z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' }) // #### Defined in -[packages/form-core/src/FieldApi.ts:198](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L198) +[packages/form-core/src/FieldApi.ts:203](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L203) *** @@ -145,7 +145,7 @@ If set to a number larger than 0, will debounce the async validation event by th #### Defined in -[packages/form-core/src/FieldApi.ts:210](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L210) +[packages/form-core/src/FieldApi.ts:215](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L215) *** @@ -159,7 +159,7 @@ An optional list of field names that should trigger this field's `onChange` and #### Defined in -[packages/form-core/src/FieldApi.ts:214](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L214) +[packages/form-core/src/FieldApi.ts:219](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L219) *** @@ -173,7 +173,7 @@ An optional function that takes a param of `formApi` which is a generic type of #### Defined in -[packages/form-core/src/FieldApi.ts:172](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L172) +[packages/form-core/src/FieldApi.ts:177](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L177) *** @@ -194,7 +194,7 @@ z.string().min(1) // if `zodAdapter` is passed #### Defined in -[packages/form-core/src/FieldApi.ts:258](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L258) +[packages/form-core/src/FieldApi.ts:263](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L263) *** @@ -215,4 +215,4 @@ z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' }) // #### Defined in -[packages/form-core/src/FieldApi.ts:271](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L271) +[packages/form-core/src/FieldApi.ts:276](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L276) diff --git a/docs/reference/type-aliases/fieldmeta.md b/docs/reference/type-aliases/fieldmeta.md index 45abbf8b9..78c13d6de 100644 --- a/docs/reference/type-aliases/fieldmeta.md +++ b/docs/reference/type-aliases/fieldmeta.md @@ -71,4 +71,4 @@ A flag indicating whether the field is currently being validated. ## Defined in -[packages/form-core/src/FieldApi.ts:407](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L407) +[packages/form-core/src/FieldApi.ts:412](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L412) diff --git a/docs/reference/type-aliases/fieldstate.md b/docs/reference/type-aliases/fieldstate.md index f5d5143b7..5ce65a14d 100644 --- a/docs/reference/type-aliases/fieldstate.md +++ b/docs/reference/type-aliases/fieldstate.md @@ -35,4 +35,4 @@ The current value of the field. ## Defined in -[packages/form-core/src/FieldApi.ts:441](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L441) +[packages/form-core/src/FieldApi.ts:446](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L446)