Skip to content

Commit 7d951c4

Browse files
committed
Merge remote-tracking branch 'chorobin/perf-annotations-deep-key-values' into perf-annotations-deep-key-values
2 parents ad978f0 + dd4c363 commit 7d951c4

23 files changed

+97
-123
lines changed

docs/reference/classes/fieldapi.md

+26-26
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: FieldApi
77

88
# Class: FieldApi\<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TParentSubmitMeta\>
99

10-
Defined in: [packages/form-core/src/FieldApi.ts:846](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L846)
10+
Defined in: [packages/form-core/src/FieldApi.ts:841](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L841)
1111

1212
A class representing the API for managing a form field.
1313

@@ -21,7 +21,7 @@ the `new FieldApi` constructor.
2121

2222
**TParentData**
2323

24-
**TName** *extends* `string`
24+
**TName** *extends* [`DeepKeys`](../type-aliases/deepkeys.md)\<`TParentData`\>
2525

2626
**TData** *extends* [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\>
2727

@@ -65,7 +65,7 @@ the `new FieldApi` constructor.
6565
new FieldApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TParentSubmitMeta>(opts): FieldApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TParentSubmitMeta>
6666
```
6767

68-
Defined in: [packages/form-core/src/FieldApi.ts:974](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L974)
68+
Defined in: [packages/form-core/src/FieldApi.ts:969](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L969)
6969

7070
Initializes a new `FieldApi` instance.
7171

@@ -87,7 +87,7 @@ Initializes a new `FieldApi` instance.
8787
form: FormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TParentSubmitMeta>;
8888
```
8989

90-
Defined in: [packages/form-core/src/FieldApi.ts:890](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L890)
90+
Defined in: [packages/form-core/src/FieldApi.ts:885](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L885)
9191

9292
A reference to the form API instance.
9393

@@ -99,7 +99,7 @@ A reference to the form API instance.
9999
name: DeepKeys<TParentData>;
100100
```
101101

102-
Defined in: [packages/form-core/src/FieldApi.ts:914](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L914)
102+
Defined in: [packages/form-core/src/FieldApi.ts:909](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L909)
103103

104104
The field name.
105105

@@ -111,7 +111,7 @@ The field name.
111111
options: FieldApiOptions<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TParentSubmitMeta>;
112112
```
113113

114-
Defined in: [packages/form-core/src/FieldApi.ts:918](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L918)
114+
Defined in: [packages/form-core/src/FieldApi.ts:913](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L913)
115115

116116
The field options.
117117

@@ -123,7 +123,7 @@ The field options.
123123
store: Derived<FieldState<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync>>;
124124
```
125125

126-
Defined in: [packages/form-core/src/FieldApi.ts:942](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L942)
126+
Defined in: [packages/form-core/src/FieldApi.ts:937](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L937)
127127

128128
The field state store.
129129

@@ -135,7 +135,7 @@ The field state store.
135135
timeoutIds: Record<ValidationCause, null | Timeout>;
136136
```
137137

138-
Defined in: [packages/form-core/src/FieldApi.ts:969](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L969)
138+
Defined in: [packages/form-core/src/FieldApi.ts:964](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L964)
139139

140140
## Accessors
141141

@@ -147,7 +147,7 @@ Defined in: [packages/form-core/src/FieldApi.ts:969](https://github.com/TanStack
147147
get state(): FieldState<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync>
148148
```
149149

150-
Defined in: [packages/form-core/src/FieldApi.ts:966](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L966)
150+
Defined in: [packages/form-core/src/FieldApi.ts:961](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L961)
151151

152152
The current field state.
153153

@@ -163,7 +163,7 @@ The current field state.
163163
getInfo(): FieldInfo<TParentData>
164164
```
165165

166-
Defined in: [packages/form-core/src/FieldApi.ts:1222](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1222)
166+
Defined in: [packages/form-core/src/FieldApi.ts:1217](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1217)
167167

168168
Gets the field information object.
169169

@@ -179,7 +179,7 @@ Gets the field information object.
179179
getMeta(): FieldMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync>
180180
```
181181

182-
Defined in: [packages/form-core/src/FieldApi.ts:1190](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1190)
182+
Defined in: [packages/form-core/src/FieldApi.ts:1185](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1185)
183183

184184
#### Returns
185185

@@ -193,7 +193,7 @@ Defined in: [packages/form-core/src/FieldApi.ts:1190](https://github.com/TanStac
193193
getValue(): TData
194194
```
195195

196-
Defined in: [packages/form-core/src/FieldApi.ts:1172](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1172)
196+
Defined in: [packages/form-core/src/FieldApi.ts:1167](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1167)
197197

198198
Gets the current field value.
199199

@@ -213,7 +213,7 @@ Use `field.state.value` instead.
213213
handleBlur(): void
214214
```
215215

216-
Defined in: [packages/form-core/src/FieldApi.ts:1633](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1633)
216+
Defined in: [packages/form-core/src/FieldApi.ts:1628](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1628)
217217

218218
Handles the blur event.
219219

@@ -229,7 +229,7 @@ Handles the blur event.
229229
handleChange(updater): void
230230
```
231231

232-
Defined in: [packages/form-core/src/FieldApi.ts:1626](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1626)
232+
Defined in: [packages/form-core/src/FieldApi.ts:1621](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1621)
233233

234234
Handles the change event.
235235

@@ -254,7 +254,7 @@ insertValue(
254254
opts?): void
255255
```
256256
257-
Defined in: [packages/form-core/src/FieldApi.ts:1242](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1242)
257+
Defined in: [packages/form-core/src/FieldApi.ts:1237](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1237)
258258
259259
Inserts a value at the specified index, shifting the subsequent values to the right.
260260
@@ -284,7 +284,7 @@ Inserts a value at the specified index, shifting the subsequent values to the ri
284284
mount(): () => void
285285
```
286286
287-
Defined in: [packages/form-core/src/FieldApi.ts:1078](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1078)
287+
Defined in: [packages/form-core/src/FieldApi.ts:1073](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1073)
288288
289289
Mounts the field instance to the form.
290290
@@ -307,7 +307,7 @@ moveValue(
307307
opts?): void
308308
```
309309
310-
Defined in: [packages/form-core/src/FieldApi.ts:1298](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1298)
310+
Defined in: [packages/form-core/src/FieldApi.ts:1293](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1293)
311311
312312
Moves the value at the first specified index to the second specified index.
313313
@@ -337,7 +337,7 @@ Moves the value at the first specified index to the second specified index.
337337
pushValue(value, opts?): void
338338
```
339339
340-
Defined in: [packages/form-core/src/FieldApi.ts:1227](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1227)
340+
Defined in: [packages/form-core/src/FieldApi.ts:1222](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1222)
341341
342342
Pushes a new value to the field.
343343
@@ -363,7 +363,7 @@ Pushes a new value to the field.
363363
removeValue(index, opts?): void
364364
```
365365
366-
Defined in: [packages/form-core/src/FieldApi.ts:1274](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1274)
366+
Defined in: [packages/form-core/src/FieldApi.ts:1269](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1269)
367367
368368
Removes a value at the specified index.
369369
@@ -392,7 +392,7 @@ replaceValue(
392392
opts?): void
393393
```
394394
395-
Defined in: [packages/form-core/src/FieldApi.ts:1258](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1258)
395+
Defined in: [packages/form-core/src/FieldApi.ts:1253](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1253)
396396
397397
Replaces a value at the specified index.
398398
@@ -422,7 +422,7 @@ Replaces a value at the specified index.
422422
setErrorMap(errorMap): void
423423
```
424424
425-
Defined in: [packages/form-core/src/FieldApi.ts:1653](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1653)
425+
Defined in: [packages/form-core/src/FieldApi.ts:1648](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1648)
426426
427427
Updates the field's errorMap
428428
@@ -444,7 +444,7 @@ Updates the field's errorMap
444444
setMeta(updater): void
445445
```
446446
447-
Defined in: [packages/form-core/src/FieldApi.ts:1195](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1195)
447+
Defined in: [packages/form-core/src/FieldApi.ts:1190](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1190)
448448
449449
Sets the field metadata.
450450
@@ -466,7 +466,7 @@ Sets the field metadata.
466466
setValue(updater, options?): void
467467
```
468468
469-
Defined in: [packages/form-core/src/FieldApi.ts:1179](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1179)
469+
Defined in: [packages/form-core/src/FieldApi.ts:1174](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1174)
470470
471471
Sets the field value and run the `change` validator.
472472
@@ -495,7 +495,7 @@ swapValues(
495495
opts?): void
496496
```
497497
498-
Defined in: [packages/form-core/src/FieldApi.ts:1286](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1286)
498+
Defined in: [packages/form-core/src/FieldApi.ts:1281](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1281)
499499
500500
Swaps the values at the specified indices.
501501
@@ -525,7 +525,7 @@ Swaps the values at the specified indices.
525525
update(opts): void
526526
```
527527
528-
Defined in: [packages/form-core/src/FieldApi.ts:1120](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1120)
528+
Defined in: [packages/form-core/src/FieldApi.ts:1115](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1115)
529529
530530
Updates the field instance with new options.
531531
@@ -547,7 +547,7 @@ Updates the field instance with new options.
547547
validate(cause, opts?): unknown[] | Promise<unknown[]>
548548
```
549549
550-
Defined in: [packages/form-core/src/FieldApi.ts:1593](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1593)
550+
Defined in: [packages/form-core/src/FieldApi.ts:1588](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1588)
551551
552552
Validates the field value.
553553

docs/reference/classes/formapi.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ Gets the field info of the specified field.
224224
225225
##### field
226226
227-
[`ValidateName`](../type-aliases/validatename.md)\<`TFormData`, `TField`\>
227+
`TField`
228228
229229
#### Returns
230230
@@ -250,7 +250,7 @@ Gets the metadata of the specified field.
250250
251251
##### field
252252
253-
[`ValidateName`](../type-aliases/validatename.md)\<`TFormData`, `TField`\>
253+
`TField`
254254
255255
#### Returns
256256
@@ -342,7 +342,7 @@ Defined in: [packages/form-core/src/FormApi.ts:1811](https://github.com/TanStack
342342
343343
##### field
344344
345-
[`ValidateName`](../type-aliases/validatename.md)\<`TFormData`, `TField`\>
345+
`TField`
346346
347347
##### index
348348
@@ -402,7 +402,7 @@ Moves the value at the first specified index to the second specified index withi
402402
403403
##### field
404404
405-
[`ValidateName`](../type-aliases/validatename.md)\<`TFormData`, `TField`\>
405+
`TField`
406406
407407
##### index1
408408
@@ -443,7 +443,7 @@ Pushes a value into an array field.
443443
444444
##### field
445445
446-
[`ValidateName`](../type-aliases/validatename.md)\<`TFormData`, `TField`\>
446+
`TField`
447447
448448
##### value
449449
@@ -480,7 +480,7 @@ Removes a value from an array field at the specified index.
480480
481481
##### field
482482
483-
[`ValidateName`](../type-aliases/validatename.md)\<`TFormData`, `TField`\>
483+
`TField`
484484
485485
##### index
486486
@@ -518,7 +518,7 @@ Replaces a value into an array field at the specified index.
518518
519519
##### field
520520
521-
[`ValidateName`](../type-aliases/validatename.md)\<`TFormData`, `TField`\>
521+
`TField`
522522
523523
##### index
524524
@@ -635,7 +635,7 @@ Updates the metadata of the specified field.
635635
636636
##### field
637637
638-
[`ValidateName`](../type-aliases/validatename.md)\<`TFormData`, `TField`\>
638+
`TField`
639639
640640
##### updater
641641
@@ -668,7 +668,7 @@ Sets the value of the specified field and optionally updates the touched state.
668668
669669
##### field
670670
671-
[`ValidateName`](../type-aliases/validatename.md)\<`TFormData`, `TField`\>
671+
`TField`
672672
673673
##### updater
674674
@@ -706,7 +706,7 @@ Swaps the values at the specified indices within an array field.
706706
707707
##### field
708708
709-
[`ValidateName`](../type-aliases/validatename.md)\<`TFormData`, `TField`\>
709+
`TField`
710710
711711
##### index1
712712
@@ -825,7 +825,7 @@ Validates a specified field in the form using the correct handlers for a given v
825825
826826
##### field
827827
828-
[`ValidateName`](../type-aliases/validatename.md)\<`TFormData`, `TField`\>
828+
`TField`
829829
830830
##### cause
831831

docs/reference/index.md

-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,6 @@ title: "@tanstack/form-core"
6363
- [UnwrapFormValidateOrFn](type-aliases/unwrapformvalidateorfn.md)
6464
- [Updater](type-aliases/updater.md)
6565
- [UpdaterFn](type-aliases/updaterfn.md)
66-
- [ValidateName](type-aliases/validatename.md)
6766
- [ValidationError](type-aliases/validationerror.md)
6867
- [ValidationMeta](type-aliases/validationmeta.md)
6968
- [ValidationSource](type-aliases/validationsource.md)

0 commit comments

Comments
 (0)