Skip to content

Commit 6571c24

Browse files
autofix-ci[bot]juanvilladev
authored andcommitted
ci: apply automated fixes and generate docs
1 parent e318591 commit 6571c24

File tree

2 files changed

+22
-22
lines changed

2 files changed

+22
-22
lines changed

docs/reference/classes/fieldapi.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ Use `field.state.value` instead.
213213
handleBlur(): void
214214
```
215215

216-
Defined in: [packages/form-core/src/FieldApi.ts:1659](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1659)
216+
Defined in: [packages/form-core/src/FieldApi.ts:1660](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1660)
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:1652](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1652)
232+
Defined in: [packages/form-core/src/FieldApi.ts:1653](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1653)
233233

234234
Handles the change event.
235235

@@ -479,7 +479,7 @@ Replaces a value at the specified index.
479479
setErrorMap(errorMap): void
480480
```
481481
482-
Defined in: [packages/form-core/src/FieldApi.ts:1679](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1679)
482+
Defined in: [packages/form-core/src/FieldApi.ts:1680](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1680)
483483
484484
Updates the field's errorMap
485485
@@ -604,7 +604,7 @@ Updates the field instance with new options.
604604
validate(cause, opts?): unknown[] | Promise<unknown[]>
605605
```
606606
607-
Defined in: [packages/form-core/src/FieldApi.ts:1619](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1619)
607+
Defined in: [packages/form-core/src/FieldApi.ts:1620](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1620)
608608
609609
Validates the field value.
610610

docs/reference/classes/formapi.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ Defined in: [packages/form-core/src/FormApi.ts:728](https://github.com/TanStack/
137137
deleteField<TField>(field): void
138138
```
139139
140-
Defined in: [packages/form-core/src/FormApi.ts:1796](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1796)
140+
Defined in: [packages/form-core/src/FormApi.ts:1797](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1797)
141141
142142
#### Type Parameters
143143
@@ -161,7 +161,7 @@ Defined in: [packages/form-core/src/FormApi.ts:1796](https://github.com/TanStack
161161
getAllErrors(): object
162162
```
163163
164-
Defined in: [packages/form-core/src/FormApi.ts:2034](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2034)
164+
Defined in: [packages/form-core/src/FormApi.ts:2035](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2035)
165165
166166
Returns form and field level errors
167167
@@ -212,7 +212,7 @@ errors: (
212212
getFieldInfo<TField>(field): FieldInfo<TFormData>
213213
```
214214
215-
Defined in: [packages/form-core/src/FormApi.ts:1710](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1710)
215+
Defined in: [packages/form-core/src/FormApi.ts:1711](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1711)
216216
217217
Gets the field info of the specified field.
218218
@@ -238,7 +238,7 @@ Gets the field info of the specified field.
238238
getFieldMeta<TField>(field): undefined | AnyFieldMeta
239239
```
240240
241-
Defined in: [packages/form-core/src/FormApi.ts:1701](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1701)
241+
Defined in: [packages/form-core/src/FormApi.ts:1702](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1702)
242242
243243
Gets the metadata of the specified field.
244244
@@ -264,7 +264,7 @@ Gets the metadata of the specified field.
264264
getFieldValue<TField>(field): DeepValue<TFormData, TField>
265265
```
266266
267-
Defined in: [packages/form-core/src/FormApi.ts:1694](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1694)
267+
Defined in: [packages/form-core/src/FormApi.ts:1695](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1695)
268268
269269
Gets the value of the specified field.
270270
@@ -292,7 +292,7 @@ Gets the value of the specified field.
292292
handleSubmit(): Promise<void>
293293
```
294294
295-
Defined in: [packages/form-core/src/FormApi.ts:1611](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1611)
295+
Defined in: [packages/form-core/src/FormApi.ts:1612](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1612)
296296
297297
Handles the form submission, performs validation, and calls the appropriate onSubmit or onInvalidSubmit callbacks.
298298
@@ -306,7 +306,7 @@ Handles the form submission, performs validation, and calls the appropriate onSu
306306
handleSubmit(submitMeta): Promise<void>
307307
```
308308
309-
Defined in: [packages/form-core/src/FormApi.ts:1612](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1612)
309+
Defined in: [packages/form-core/src/FormApi.ts:1613](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1613)
310310
311311
Handles the form submission, performs validation, and calls the appropriate onSubmit or onInvalidSubmit callbacks.
312312
@@ -332,7 +332,7 @@ insertFieldValue<TField>(
332332
opts?): Promise<void>
333333
```
334334
335-
Defined in: [packages/form-core/src/FormApi.ts:1835](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1835)
335+
Defined in: [packages/form-core/src/FormApi.ts:1836](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1836)
336336
337337
#### Type Parameters
338338
@@ -390,7 +390,7 @@ moveFieldValues<TField>(
390390
opts?): void
391391
```
392392
393-
Defined in: [packages/form-core/src/FormApi.ts:1959](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1959)
393+
Defined in: [packages/form-core/src/FormApi.ts:1960](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1960)
394394
395395
Moves the value at the first specified index to the second specified index within an array field.
396396
@@ -500,7 +500,7 @@ pushFieldValue<TField>(
500500
opts?): void
501501
```
502502

503-
Defined in: [packages/form-core/src/FormApi.ts:1820](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1820)
503+
Defined in: [packages/form-core/src/FormApi.ts:1821](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1821)
504504

505505
Pushes a value into an array field.
506506

@@ -537,7 +537,7 @@ removeFieldValue<TField>(
537537
opts?): Promise<void>
538538
```
539539

540-
Defined in: [packages/form-core/src/FormApi.ts:1893](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1893)
540+
Defined in: [packages/form-core/src/FormApi.ts:1894](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1894)
541541

542542
Removes a value from an array field at the specified index.
543543

@@ -575,7 +575,7 @@ replaceFieldValue<TField>(
575575
opts?): Promise<void>
576576
```
577577

578-
Defined in: [packages/form-core/src/FormApi.ts:1867](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1867)
578+
Defined in: [packages/form-core/src/FormApi.ts:1868](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1868)
579579

580580
Replaces a value into an array field at the specified index.
581581

@@ -646,7 +646,7 @@ Optional options to control the reset behavior.
646646
resetField<TField>(field): void
647647
```
648648

649-
Defined in: [packages/form-core/src/FormApi.ts:1987](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1987)
649+
Defined in: [packages/form-core/src/FormApi.ts:1988](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1988)
650650

651651
Resets the field value and meta to default state
652652

@@ -672,7 +672,7 @@ Resets the field value and meta to default state
672672
resetFieldMeta<TField>(fieldMeta): Record<TField, AnyFieldMeta>
673673
```
674674

675-
Defined in: [packages/form-core/src/FormApi.ts:1750](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1750)
675+
Defined in: [packages/form-core/src/FormApi.ts:1751](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1751)
676676

677677
resets every field's meta
678678

@@ -698,7 +698,7 @@ resets every field's meta
698698
setErrorMap(errorMap): void
699699
```
700700

701-
Defined in: [packages/form-core/src/FormApi.ts:2008](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2008)
701+
Defined in: [packages/form-core/src/FormApi.ts:2009](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2009)
702702

703703
Updates the form's errorMap
704704

@@ -720,7 +720,7 @@ Updates the form's errorMap
720720
setFieldMeta<TField>(field, updater): void
721721
```
722722

723-
Defined in: [packages/form-core/src/FormApi.ts:1729](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1729)
723+
Defined in: [packages/form-core/src/FormApi.ts:1730](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1730)
724724

725725
Updates the metadata of the specified field.
726726

@@ -753,7 +753,7 @@ setFieldValue<TField>(
753753
opts?): void
754754
```
755755

756-
Defined in: [packages/form-core/src/FormApi.ts:1766](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1766)
756+
Defined in: [packages/form-core/src/FormApi.ts:1767](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1767)
757757

758758
Sets the value of the specified field and optionally updates the touched state.
759759

@@ -791,7 +791,7 @@ swapFieldValues<TField>(
791791
opts?): void
792792
```
793793

794-
Defined in: [packages/form-core/src/FormApi.ts:1930](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1930)
794+
Defined in: [packages/form-core/src/FormApi.ts:1931](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1931)
795795

796796
Swaps the values at the specified indices within an array field.
797797

0 commit comments

Comments
 (0)