Skip to content

Commit efa5dd7

Browse files
ci: apply automated fixes and generate docs
1 parent dbe31cd commit efa5dd7

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

docs/reference/classes/formapi.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ Defined in: [packages/form-core/src/FormApi.ts:953](https://github.com/TanStack/
161161
clearFieldValues<TField>(field, options?): void
162162
```
163163
164-
Defined in: [packages/form-core/src/FormApi.ts:2437](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2437)
164+
Defined in: [packages/form-core/src/FormApi.ts:2444](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2444)
165165
166166
Clear all values within an array field.
167167
@@ -197,7 +197,7 @@ FieldManipulator.clearFieldValues
197197
deleteField<TField>(field): void
198198
```
199199
200-
Defined in: [packages/form-core/src/FormApi.ts:2246](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2246)
200+
Defined in: [packages/form-core/src/FormApi.ts:2253](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2253)
201201
202202
#### Type Parameters
203203
@@ -227,7 +227,7 @@ FieldManipulator.deleteField
227227
getAllErrors(): object
228228
```
229229
230-
Defined in: [packages/form-core/src/FormApi.ts:2549](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2549)
230+
Defined in: [packages/form-core/src/FormApi.ts:2556](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2556)
231231
232232
Returns form and field level errors
233233
@@ -280,7 +280,7 @@ errors: (
280280
getFieldInfo<TField>(field): FieldInfo<TFormData>
281281
```
282282
283-
Defined in: [packages/form-core/src/FormApi.ts:2149](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2149)
283+
Defined in: [packages/form-core/src/FormApi.ts:2156](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2156)
284284
285285
Gets the field info of the specified field.
286286
@@ -306,7 +306,7 @@ Gets the field info of the specified field.
306306
getFieldMeta<TField>(field): undefined | AnyFieldMeta
307307
```
308308
309-
Defined in: [packages/form-core/src/FormApi.ts:2140](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2140)
309+
Defined in: [packages/form-core/src/FormApi.ts:2147](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2147)
310310
311311
Gets the metadata of the specified field.
312312
@@ -338,7 +338,7 @@ FieldManipulator.getFieldMeta
338338
getFieldValue<TField>(field): DeepValue<TFormData, TField>
339339
```
340340
341-
Defined in: [packages/form-core/src/FormApi.ts:2133](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2133)
341+
Defined in: [packages/form-core/src/FormApi.ts:2140](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2140)
342342
343343
Gets the value of the specified field.
344344
@@ -424,7 +424,7 @@ insertFieldValue<TField>(
424424
options?): Promise<void>
425425
```
426426
427-
Defined in: [packages/form-core/src/FormApi.ts:2284](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2284)
427+
Defined in: [packages/form-core/src/FormApi.ts:2291](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2291)
428428
429429
#### Type Parameters
430430
@@ -488,7 +488,7 @@ moveFieldValues<TField>(
488488
options?): void
489489
```
490490
491-
Defined in: [packages/form-core/src/FormApi.ts:2408](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2408)
491+
Defined in: [packages/form-core/src/FormApi.ts:2415](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2415)
492492
493493
Moves the value at the first specified index to the second specified index within an array field.
494494
@@ -537,7 +537,7 @@ parseValuesWithSchema(schema):
537537
}
538538
```
539539

540-
Defined in: [packages/form-core/src/FormApi.ts:2613](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2613)
540+
Defined in: [packages/form-core/src/FormApi.ts:2620](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2620)
541541

542542
Parses the form's values with a given standard schema and returns
543543
issues (if any). This method does NOT set any internal errors.
@@ -571,7 +571,7 @@ parseValuesWithSchemaAsync(schema): Promise<
571571
}>
572572
```
573573

574-
Defined in: [packages/form-core/src/FormApi.ts:2625](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2625)
574+
Defined in: [packages/form-core/src/FormApi.ts:2632](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2632)
575575

576576
Parses the form's values with a given standard schema and returns
577577
issues (if any). This method does NOT set any internal errors.
@@ -604,7 +604,7 @@ pushFieldValue<TField>(
604604
options?): void
605605
```
606606

607-
Defined in: [packages/form-core/src/FormApi.ts:2270](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2270)
607+
Defined in: [packages/form-core/src/FormApi.ts:2277](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2277)
608608

609609
Pushes a value into an array field.
610610

@@ -647,7 +647,7 @@ removeFieldValue<TField>(
647647
options?): Promise<void>
648648
```
649649

650-
Defined in: [packages/form-core/src/FormApi.ts:2342](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2342)
650+
Defined in: [packages/form-core/src/FormApi.ts:2349](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2349)
651651

652652
Removes a value from an array field at the specified index.
653653

@@ -691,7 +691,7 @@ replaceFieldValue<TField>(
691691
options?): Promise<void>
692692
```
693693

694-
Defined in: [packages/form-core/src/FormApi.ts:2316](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2316)
694+
Defined in: [packages/form-core/src/FormApi.ts:2323](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2323)
695695

696696
Replaces a value into an array field at the specified index.
697697

@@ -768,7 +768,7 @@ Optional options to control the reset behavior.
768768
resetField<TField>(field): void
769769
```
770770

771-
Defined in: [packages/form-core/src/FormApi.ts:2467](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2467)
771+
Defined in: [packages/form-core/src/FormApi.ts:2474](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2474)
772772

773773
Resets the field value and meta to default state
774774

@@ -800,7 +800,7 @@ FieldManipulator.resetField
800800
resetFieldMeta<TField>(fieldMeta): Record<TField, AnyFieldMeta>
801801
```
802802

803-
Defined in: [packages/form-core/src/FormApi.ts:2190](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2190)
803+
Defined in: [packages/form-core/src/FormApi.ts:2197](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2197)
804804

805805
resets every field's meta
806806

@@ -826,7 +826,7 @@ resets every field's meta
826826
setErrorMap(errorMap): void
827827
```
828828

829-
Defined in: [packages/form-core/src/FormApi.ts:2485](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2485)
829+
Defined in: [packages/form-core/src/FormApi.ts:2492](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2492)
830830

831831
Updates the form's errorMap
832832

@@ -848,7 +848,7 @@ Updates the form's errorMap
848848
setFieldMeta<TField>(field, updater): void
849849
```
850850

851-
Defined in: [packages/form-core/src/FormApi.ts:2169](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2169)
851+
Defined in: [packages/form-core/src/FormApi.ts:2176](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2176)
852852

853853
Updates the metadata of the specified field.
854854

@@ -887,7 +887,7 @@ setFieldValue<TField>(
887887
opts?): void
888888
```
889889

890-
Defined in: [packages/form-core/src/FormApi.ts:2206](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2206)
890+
Defined in: [packages/form-core/src/FormApi.ts:2213](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2213)
891891

892892
Sets the value of the specified field and optionally updates the touched state.
893893

@@ -931,7 +931,7 @@ swapFieldValues<TField>(
931931
options?): void
932932
```
933933

934-
Defined in: [packages/form-core/src/FormApi.ts:2379](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2379)
934+
Defined in: [packages/form-core/src/FormApi.ts:2386](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2386)
935935

936936
Swaps the values at the specified indices within an array field.
937937

0 commit comments

Comments
 (0)