Skip to content

Commit a2f3923

Browse files
ci: apply automated fixes and generate docs
1 parent fade2f0 commit a2f3923

File tree

1 file changed

+37
-37
lines changed

1 file changed

+37
-37
lines changed

docs/reference/classes/formapi.md

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ deleteField<TField>(field): void
121121
122122
#### Defined in
123123
124-
[packages/form-core/src/FormApi.ts:1076](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1076)
124+
[packages/form-core/src/FormApi.ts:1084](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1084)
125125
126126
***
127127
@@ -147,7 +147,7 @@ Gets the field info of the specified field.
147147
148148
#### Defined in
149149
150-
[packages/form-core/src/FormApi.ts:992](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L992)
150+
[packages/form-core/src/FormApi.ts:1000](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1000)
151151
152152
***
153153
@@ -173,7 +173,7 @@ Gets the metadata of the specified field.
173173
174174
#### Defined in
175175
176-
[packages/form-core/src/FormApi.ts:983](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L983)
176+
[packages/form-core/src/FormApi.ts:991](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L991)
177177
178178
***
179179
@@ -199,7 +199,7 @@ Gets the value of the specified field.
199199
200200
#### Defined in
201201
202-
[packages/form-core/src/FormApi.ts:976](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L976)
202+
[packages/form-core/src/FormApi.ts:984](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L984)
203203
204204
***
205205
@@ -217,17 +217,17 @@ Handles the form submission, performs validation, and calls the appropriate onSu
217217
218218
#### Defined in
219219
220-
[packages/form-core/src/FormApi.ts:916](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L916)
220+
[packages/form-core/src/FormApi.ts:911](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L911)
221221
222222
***
223223
224224
### insertFieldValue()
225225
226226
```ts
227227
insertFieldValue<TField>(
228-
field,
229-
index,
230-
value,
228+
field,
229+
index,
230+
value,
231231
opts?): Promise<void>
232232
```
233233
@@ -253,7 +253,7 @@ Inserts a value into an array field at the specified index, shifting the subsequ
253253
254254
#### Defined in
255255
256-
[packages/form-core/src/FormApi.ts:1108](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1108)
256+
[packages/form-core/src/FormApi.ts:1116](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1116)
257257
258258
***
259259
@@ -277,9 +277,9 @@ mount(): void
277277
278278
```ts
279279
moveFieldValues<TField>(
280-
field,
281-
index1,
282-
index2,
280+
field,
281+
index1,
282+
index2,
283283
opts?): void
284284
```
285285
@@ -305,16 +305,16 @@ Moves the value at the first specified index to the second specified index withi
305305
306306
#### Defined in
307307
308-
[packages/form-core/src/FormApi.ts:1226](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1226)
308+
[packages/form-core/src/FormApi.ts:1234](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1234)
309309
310310
***
311311
312312
### pushFieldValue()
313313
314314
```ts
315315
pushFieldValue<TField>(
316-
field,
317-
value,
316+
field,
317+
value,
318318
opts?): void
319319
```
320320
@@ -338,16 +338,16 @@ Pushes a value into an array field.
338338
339339
#### Defined in
340340
341-
[packages/form-core/src/FormApi.ts:1090](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1090)
341+
[packages/form-core/src/FormApi.ts:1098](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1098)
342342
343343
***
344344
345345
### removeFieldValue()
346346
347347
```ts
348348
removeFieldValue<TField>(
349-
field,
350-
index,
349+
field,
350+
index,
351351
opts?): Promise<void>
352352
```
353353
@@ -371,17 +371,17 @@ Removes a value from an array field at the specified index.
371371
372372
#### Defined in
373373
374-
[packages/form-core/src/FormApi.ts:1161](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1161)
374+
[packages/form-core/src/FormApi.ts:1169](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1169)
375375
376376
***
377377
378378
### replaceFieldValue()
379379
380380
```ts
381381
replaceFieldValue<TField>(
382-
field,
383-
index,
384-
value,
382+
field,
383+
index,
384+
value,
385385
opts?): Promise<void>
386386
```
387387
@@ -407,7 +407,7 @@ Replaces a value into an array field at the specified index.
407407
408408
#### Defined in
409409
410-
[packages/form-core/src/FormApi.ts:1135](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1135)
410+
[packages/form-core/src/FormApi.ts:1143](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1143)
411411
412412
***
413413
@@ -449,7 +449,7 @@ resetFieldMeta<TField>(fieldMeta): Record<TField, FieldMeta>
449449
450450
#### Defined in
451451
452-
[packages/form-core/src/FormApi.ts:1026](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1026)
452+
[packages/form-core/src/FormApi.ts:1034](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1034)
453453
454454
***
455455
@@ -471,7 +471,7 @@ Updates the form's errorMap
471471
472472
#### Defined in
473473
474-
[packages/form-core/src/FormApi.ts:1250](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1250)
474+
[packages/form-core/src/FormApi.ts:1258](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1258)
475475
476476
***
477477
@@ -499,16 +499,16 @@ Updates the metadata of the specified field.
499499
500500
#### Defined in
501501
502-
[packages/form-core/src/FormApi.ts:1011](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1011)
502+
[packages/form-core/src/FormApi.ts:1019](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1019)
503503
504504
***
505505
506506
### setFieldValue()
507507
508508
```ts
509509
setFieldValue<TField>(
510-
field,
511-
updater,
510+
field,
511+
updater,
512512
opts?): void
513513
```
514514
@@ -532,17 +532,17 @@ Sets the value of the specified field and optionally updates the touched state.
532532
533533
#### Defined in
534534
535-
[packages/form-core/src/FormApi.ts:1050](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1050)
535+
[packages/form-core/src/FormApi.ts:1058](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1058)
536536
537537
***
538538
539539
### swapFieldValues()
540540
541541
```ts
542542
swapFieldValues<TField>(
543-
field,
544-
index1,
545-
index2,
543+
field,
544+
index1,
545+
index2,
546546
opts?): void
547547
```
548548
@@ -568,7 +568,7 @@ Swaps the values at the specified indices within an array field.
568568
569569
#### Defined in
570570
571-
[packages/form-core/src/FormApi.ts:1200](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1200)
571+
[packages/form-core/src/FormApi.ts:1208](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1208)
572572
573573
***
574574
@@ -620,8 +620,8 @@ Validates all fields in the form using the correct handlers for a given validati
620620
621621
```ts
622622
validateArrayFieldsStartingFrom<TField>(
623-
field,
624-
index,
623+
field,
624+
index,
625625
cause): Promise<ValidationError[]>
626626
```
627627
@@ -645,7 +645,7 @@ Validates the children of a specified array in the form starting from a given in
645645
646646
#### Defined in
647647
648-
[packages/form-core/src/FormApi.ts:611](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L611)
648+
[packages/form-core/src/FormApi.ts:605](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L605)
649649
650650
***
651651
@@ -673,4 +673,4 @@ Validates a specified field in the form using the correct handlers for a given v
673673
674674
#### Defined in
675675
676-
[packages/form-core/src/FormApi.ts:650](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L650)
676+
[packages/form-core/src/FormApi.ts:644](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L644)

0 commit comments

Comments
 (0)