Skip to content

Commit cec6f48

Browse files
ci: apply automated fixes and generate docs
1 parent e32b27f commit cec6f48

File tree

2 files changed

+48
-48
lines changed

2 files changed

+48
-48
lines changed

docs/reference/classes/FieldApi.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ The current field state.
233233
clearValues(options?): void;
234234
```
235235
236-
Defined in: [packages/form-core/src/FieldApi.ts:1524](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1524)
236+
Defined in: [packages/form-core/src/FieldApi.ts:1525](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1525)
237237
238238
Clear all values from the array.
239239
@@ -255,7 +255,7 @@ Clear all values from the array.
255255
getInfo(): FieldInfo<TParentData>;
256256
```
257257
258-
Defined in: [packages/form-core/src/FieldApi.ts:1410](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1410)
258+
Defined in: [packages/form-core/src/FieldApi.ts:1411](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1411)
259259
260260
Gets the field information object.
261261
@@ -271,7 +271,7 @@ Gets the field information object.
271271
getMeta(): FieldMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync>;
272272
```
273273
274-
Defined in: [packages/form-core/src/FieldApi.ts:1374](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1374)
274+
Defined in: [packages/form-core/src/FieldApi.ts:1375](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1375)
275275
276276
#### Returns
277277
@@ -285,7 +285,7 @@ Defined in: [packages/form-core/src/FieldApi.ts:1374](https://github.com/TanStac
285285
getValue(): TData;
286286
```
287287
288-
Defined in: [packages/form-core/src/FieldApi.ts:1351](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1351)
288+
Defined in: [packages/form-core/src/FieldApi.ts:1352](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1352)
289289
290290
Gets the current field value.
291291
@@ -305,7 +305,7 @@ Use `field.state.value` instead.
305305
handleBlur(): void;
306306
```
307307
308-
Defined in: [packages/form-core/src/FieldApi.ts:1912](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1912)
308+
Defined in: [packages/form-core/src/FieldApi.ts:1913](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1913)
309309
310310
Handles the blur event.
311311
@@ -321,7 +321,7 @@ Handles the blur event.
321321
handleChange(updater): void;
322322
```
323323
324-
Defined in: [packages/form-core/src/FieldApi.ts:1905](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1905)
324+
Defined in: [packages/form-core/src/FieldApi.ts:1906](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1906)
325325
326326
Handles the change event.
327327
@@ -346,7 +346,7 @@ insertValue(
346346
options?): void;
347347
```
348348
349-
Defined in: [packages/form-core/src/FieldApi.ts:1433](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1433)
349+
Defined in: [packages/form-core/src/FieldApi.ts:1434](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1434)
350350
351351
Inserts a value at the specified index, shifting the subsequent values to the right.
352352
@@ -401,7 +401,7 @@ moveValue(
401401
options?): void;
402402
```
403403
404-
Defined in: [packages/form-core/src/FieldApi.ts:1508](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1508)
404+
Defined in: [packages/form-core/src/FieldApi.ts:1509](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1509)
405405
406406
Moves the value at the first specified index to the second specified index.
407407
@@ -433,7 +433,7 @@ parseValueWithSchema(schema):
433433
| undefined;
434434
```
435435
436-
Defined in: [packages/form-core/src/FieldApi.ts:1955](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1955)
436+
Defined in: [packages/form-core/src/FieldApi.ts:1956](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1956)
437437
438438
Parses the field's value with the given schema and returns
439439
issues (if any). This method does NOT set any internal errors.
@@ -461,7 +461,7 @@ parseValueWithSchemaAsync(schema): Promise<
461461
| undefined>;
462462
```
463463
464-
Defined in: [packages/form-core/src/FieldApi.ts:1967](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1967)
464+
Defined in: [packages/form-core/src/FieldApi.ts:1968](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1968)
465465
466466
Parses the field's value with the given schema and returns
467467
issues (if any). This method does NOT set any internal errors.
@@ -488,7 +488,7 @@ The standard schema to parse this field's value with.
488488
pushValue(value, options?): void;
489489
```
490490
491-
Defined in: [packages/form-core/src/FieldApi.ts:1415](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1415)
491+
Defined in: [packages/form-core/src/FieldApi.ts:1416](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1416)
492492
493493
Pushes a new value to the field.
494494
@@ -514,7 +514,7 @@ Pushes a new value to the field.
514514
removeValue(index, options?): void;
515515
```
516516
517-
Defined in: [packages/form-core/src/FieldApi.ts:1473](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1473)
517+
Defined in: [packages/form-core/src/FieldApi.ts:1474](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1474)
518518
519519
Removes a value at the specified index.
520520
@@ -543,7 +543,7 @@ replaceValue(
543543
options?): void;
544544
```
545545
546-
Defined in: [packages/form-core/src/FieldApi.ts:1453](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1453)
546+
Defined in: [packages/form-core/src/FieldApi.ts:1454](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1454)
547547
548548
Replaces a value at the specified index.
549549
@@ -573,7 +573,7 @@ Replaces a value at the specified index.
573573
setErrorMap(errorMap): void;
574574
```
575575
576-
Defined in: [packages/form-core/src/FieldApi.ts:1928](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1928)
576+
Defined in: [packages/form-core/src/FieldApi.ts:1929](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1929)
577577
578578
Updates the field's errorMap
579579
@@ -595,7 +595,7 @@ Updates the field's errorMap
595595
setMeta(updater): void;
596596
```
597597
598-
Defined in: [packages/form-core/src/FieldApi.ts:1379](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1379)
598+
Defined in: [packages/form-core/src/FieldApi.ts:1380](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1380)
599599
600600
Sets the field metadata.
601601
@@ -617,7 +617,7 @@ Sets the field metadata.
617617
setValue(updater, options?): void;
618618
```
619619
620-
Defined in: [packages/form-core/src/FieldApi.ts:1358](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1358)
620+
Defined in: [packages/form-core/src/FieldApi.ts:1359](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1359)
621621
622622
Sets the field value and run the `change` validator.
623623
@@ -646,7 +646,7 @@ swapValues(
646646
options?): void;
647647
```
648648
649-
Defined in: [packages/form-core/src/FieldApi.ts:1488](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1488)
649+
Defined in: [packages/form-core/src/FieldApi.ts:1489](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1489)
650650
651651
Swaps the values at the specified indices.
652652
@@ -676,7 +676,7 @@ Swaps the values at the specified indices.
676676
update(opts): void;
677677
```
678678
679-
Defined in: [packages/form-core/src/FieldApi.ts:1300](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1300)
679+
Defined in: [packages/form-core/src/FieldApi.ts:1301](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1301)
680680
681681
Updates the field instance with new options.
682682
@@ -698,7 +698,7 @@ Updates the field instance with new options.
698698
validate(cause, opts?): unknown[] | Promise<unknown[]>;
699699
```
700700
701-
Defined in: [packages/form-core/src/FieldApi.ts:1872](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1872)
701+
Defined in: [packages/form-core/src/FieldApi.ts:1873](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1873)
702702
703703
Validates the field value.
704704

0 commit comments

Comments
 (0)