Skip to content

Commit e2294eb

Browse files
autofix-ci[bot]Harry Whorlow
authored andcommitted
ci: apply automated fixes and generate docs
1 parent b2d1cba commit e2294eb

File tree

1 file changed

+39
-11
lines changed

1 file changed

+39
-11
lines changed

docs/reference/classes/formapi.md

Lines changed: 39 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ Defined in: [packages/form-core/src/FormApi.ts:718](https://github.com/TanStack/
137137
deleteField<TField>(field): void
138138
```
139139
140-
Defined in: [packages/form-core/src/FormApi.ts:1772](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1772)
140+
Defined in: [packages/form-core/src/FormApi.ts:1775](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1775)
141141
142142
#### Type Parameters
143143
@@ -161,7 +161,7 @@ Defined in: [packages/form-core/src/FormApi.ts:1772](https://github.com/TanStack
161161
getAllErrors(): object
162162
```
163163
164-
Defined in: [packages/form-core/src/FormApi.ts:1988](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1988)
164+
Defined in: [packages/form-core/src/FormApi.ts:2021](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2021)
165165
166166
Returns form and field level errors
167167
@@ -332,7 +332,7 @@ insertFieldValue<TField>(
332332
opts?): Promise<void>
333333
```
334334
335-
Defined in: [packages/form-core/src/FormApi.ts:1811](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1811)
335+
Defined in: [packages/form-core/src/FormApi.ts:1814](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1814)
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:1935](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1935)
393+
Defined in: [packages/form-core/src/FormApi.ts:1938](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1938)
394394
395395
Moves the value at the first specified index to the second specified index within an array field.
396396
@@ -431,7 +431,7 @@ pushFieldValue<TField>(
431431
opts?): void
432432
```
433433
434-
Defined in: [packages/form-core/src/FormApi.ts:1796](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1796)
434+
Defined in: [packages/form-core/src/FormApi.ts:1799](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1799)
435435
436436
Pushes a value into an array field.
437437
@@ -468,7 +468,7 @@ removeFieldValue<TField>(
468468
opts?): Promise<void>
469469
```
470470
471-
Defined in: [packages/form-core/src/FormApi.ts:1869](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1869)
471+
Defined in: [packages/form-core/src/FormApi.ts:1872](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1872)
472472
473473
Removes a value from an array field at the specified index.
474474
@@ -506,7 +506,7 @@ replaceFieldValue<TField>(
506506
opts?): Promise<void>
507507
```
508508
509-
Defined in: [packages/form-core/src/FormApi.ts:1843](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1843)
509+
Defined in: [packages/form-core/src/FormApi.ts:1846](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1846)
510510
511511
Replaces a value into an array field at the specified index.
512512
@@ -571,13 +571,41 @@ Optional options to control the reset behavior.
571571
572572
***
573573
574+
### resetField()
575+
576+
```ts
577+
resetField<TField>(field): void
578+
```
579+
580+
Defined in: [packages/form-core/src/FormApi.ts:1966](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1966)
581+
582+
Resets the field value and meta to default state
583+
584+
#### Type Parameters
585+
586+
• **TField** *extends* `string` \| `number`
587+
588+
#### Parameters
589+
590+
##### field
591+
592+
`TField`
593+
594+
#### Returns
595+
596+
`void`
597+
598+
***
599+
574600
### resetFieldMeta()
575601
576602
```ts
577603
resetFieldMeta<TField>(fieldMeta): Record<TField, AnyFieldMeta>
578604
```
579605
580-
Defined in: [packages/form-core/src/FormApi.ts:1718](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1718)
606+
Defined in: [packages/form-core/src/FormApi.ts:1721](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1721)
607+
608+
resets every field's meta
581609
582610
#### Type Parameters
583611
@@ -601,7 +629,7 @@ Defined in: [packages/form-core/src/FormApi.ts:1718](https://github.com/TanStack
601629
setErrorMap(errorMap): void
602630
```
603631
604-
Defined in: [packages/form-core/src/FormApi.ts:1962](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1962)
632+
Defined in: [packages/form-core/src/FormApi.ts:1995](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1995)
605633
606634
Updates the form's errorMap
607635
@@ -656,7 +684,7 @@ setFieldValue<TField>(
656684
opts?): void
657685
```
658686
659-
Defined in: [packages/form-core/src/FormApi.ts:1742](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1742)
687+
Defined in: [packages/form-core/src/FormApi.ts:1745](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1745)
660688
661689
Sets the value of the specified field and optionally updates the touched state.
662690
@@ -694,7 +722,7 @@ swapFieldValues<TField>(
694722
opts?): void
695723
```
696724
697-
Defined in: [packages/form-core/src/FormApi.ts:1906](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1906)
725+
Defined in: [packages/form-core/src/FormApi.ts:1909](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1909)
698726
699727
Swaps the values at the specified indices within an array field.
700728

0 commit comments

Comments
 (0)