Skip to content

Commit f58c1e7

Browse files
ci: apply automated fixes and generate docs
1 parent 08c9bed commit f58c1e7

24 files changed

+83
-54
lines changed

docs/reference/classes/formapi.md

+21-21
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ Defined in: [packages/form-core/src/FormApi.ts:830](https://github.com/TanStack/
137137
deleteField<TField>(field): void
138138
```
139139
140-
Defined in: [packages/form-core/src/FormApi.ts:1938](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1938)
140+
Defined in: [packages/form-core/src/FormApi.ts:1940](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1940)
141141
142142
#### Type Parameters
143143
@@ -161,7 +161,7 @@ Defined in: [packages/form-core/src/FormApi.ts:1938](https://github.com/TanStack
161161
getAllErrors(): object
162162
```
163163
164-
Defined in: [packages/form-core/src/FormApi.ts:2212](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2212)
164+
Defined in: [packages/form-core/src/FormApi.ts:2214](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2214)
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:1852](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1852)
215+
Defined in: [packages/form-core/src/FormApi.ts:1854](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1854)
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:1843](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1843)
241+
Defined in: [packages/form-core/src/FormApi.ts:1845](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1845)
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:1836](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1836)
267+
Defined in: [packages/form-core/src/FormApi.ts:1838](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1838)
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:1738](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1738)
295+
Defined in: [packages/form-core/src/FormApi.ts:1740](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1740)
296296
297297
Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid 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:1739](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1739)
309+
Defined in: [packages/form-core/src/FormApi.ts:1741](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1741)
310310
311311
Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks.
312312
@@ -332,7 +332,7 @@ insertFieldValue<TField>(
332332
opts?): Promise<void>
333333
```
334334
335-
Defined in: [packages/form-core/src/FormApi.ts:1977](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1977)
335+
Defined in: [packages/form-core/src/FormApi.ts:1979](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1979)
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:2101](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2101)
393+
Defined in: [packages/form-core/src/FormApi.ts:2103](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2103)
394394
395395
Moves the value at the first specified index to the second specified index within an array field.
396396
@@ -433,7 +433,7 @@ parseValuesWithSchema(schema):
433433
}
434434
```
435435

436-
Defined in: [packages/form-core/src/FormApi.ts:2272](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2272)
436+
Defined in: [packages/form-core/src/FormApi.ts:2274](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2274)
437437

438438
Parses the form's values with a given standard schema and returns
439439
issues (if any). This method does NOT set any internal errors.
@@ -467,7 +467,7 @@ parseValuesWithSchemaAsync(schema): Promise<
467467
}>
468468
```
469469

470-
Defined in: [packages/form-core/src/FormApi.ts:2284](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2284)
470+
Defined in: [packages/form-core/src/FormApi.ts:2286](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2286)
471471

472472
Parses the form's values with a given standard schema and returns
473473
issues (if any). This method does NOT set any internal errors.
@@ -500,7 +500,7 @@ pushFieldValue<TField>(
500500
opts?): void
501501
```
502502

503-
Defined in: [packages/form-core/src/FormApi.ts:1962](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1962)
503+
Defined in: [packages/form-core/src/FormApi.ts:1964](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1964)
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:2035](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2035)
540+
Defined in: [packages/form-core/src/FormApi.ts:2037](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2037)
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:2009](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2009)
578+
Defined in: [packages/form-core/src/FormApi.ts:2011](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2011)
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:2129](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2129)
649+
Defined in: [packages/form-core/src/FormApi.ts:2131](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2131)
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:1892](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1892)
675+
Defined in: [packages/form-core/src/FormApi.ts:1894](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1894)
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:2150](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2150)
701+
Defined in: [packages/form-core/src/FormApi.ts:2152](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2152)
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:1871](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1871)
723+
Defined in: [packages/form-core/src/FormApi.ts:1873](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1873)
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:1908](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1908)
756+
Defined in: [packages/form-core/src/FormApi.ts:1910](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1910)
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:2072](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2072)
794+
Defined in: [packages/form-core/src/FormApi.ts:2074](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2074)
795795

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

@@ -910,7 +910,7 @@ Validates the children of a specified array in the form starting from a given in
910910
validateField<TField>(field, cause): unknown[] | Promise<unknown[]>
911911
```
912912

913-
Defined in: [packages/form-core/src/FormApi.ts:1351](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1351)
913+
Defined in: [packages/form-core/src/FormApi.ts:1353](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1353)
914914

915915
Validates a specified field in the form using the correct handlers for a given validation type.
916916

docs/reference/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ title: "@tanstack/form-core"
4747
- [DeepKeys](type-aliases/deepkeys.md)
4848
- [DeepKeysAndValues](type-aliases/deepkeysandvalues.md)
4949
- [DeepKeysAndValuesImpl](type-aliases/deepkeysandvaluesimpl.md)
50+
- [DeepKeysOfType](type-aliases/deepkeysoftype.md)
5051
- [DeepRecord](type-aliases/deeprecord.md)
5152
- [DeepValue](type-aliases/deepvalue.md)
5253
- [DerivedFormState](type-aliases/derivedformstate.md)

docs/reference/interfaces/anydeepkeyandvalue.md

+11-5
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: AnyDeepKeyAndValue
55

66
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
77

8-
# Interface: AnyDeepKeyAndValue
8+
# Interface: AnyDeepKeyAndValue\<K, V\>
99

1010
Defined in: [packages/form-core/src/util-types.ts:22](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L22)
1111

@@ -16,22 +16,28 @@ Defined in: [packages/form-core/src/util-types.ts:22](https://github.com/TanStac
1616
- [`ObjectDeepKeyAndValue`](objectdeepkeyandvalue.md)
1717
- [`UnknownDeepKeyAndValue`](unknowndeepkeyandvalue.md)
1818

19+
## Type Parameters
20+
21+
**K** *extends* `string` = `string`
22+
23+
**V** *extends* `any` = `any`
24+
1925
## Properties
2026

2127
### key
2228

2329
```ts
24-
key: string;
30+
key: K;
2531
```
2632

27-
Defined in: [packages/form-core/src/util-types.ts:23](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L23)
33+
Defined in: [packages/form-core/src/util-types.ts:26](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L26)
2834

2935
***
3036

3137
### value
3238

3339
```ts
34-
value: any;
40+
value: V;
3541
```
3642

37-
Defined in: [packages/form-core/src/util-types.ts:24](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L24)
43+
Defined in: [packages/form-core/src/util-types.ts:27](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L27)

docs/reference/interfaces/arraydeepkeyandvalue.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: ArrayDeepKeyAndValue
77

88
# Interface: ArrayDeepKeyAndValue\<TParent, T\>
99

10-
Defined in: [packages/form-core/src/util-types.ts:30](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L30)
10+
Defined in: [packages/form-core/src/util-types.ts:33](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L33)
1111

1212
## Extends
1313

@@ -27,7 +27,7 @@ Defined in: [packages/form-core/src/util-types.ts:30](https://github.com/TanStac
2727
key: `${TParent["key"] extends never ? "" : TParent["key"]}[${number}]`;
2828
```
2929

30-
Defined in: [packages/form-core/src/util-types.ts:34](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L34)
30+
Defined in: [packages/form-core/src/util-types.ts:37](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L37)
3131

3232
#### Overrides
3333

@@ -43,7 +43,7 @@ value:
4343
| Nullable<TParent["value"]>;
4444
```
4545

46-
Defined in: [packages/form-core/src/util-types.ts:35](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L35)
46+
Defined in: [packages/form-core/src/util-types.ts:38](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L38)
4747

4848
#### Overrides
4949

docs/reference/interfaces/objectdeepkeyandvalue.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: ObjectDeepKeyAndValue
77

88
# Interface: ObjectDeepKeyAndValue\<TParent, T, TKey\>
99

10-
Defined in: [packages/form-core/src/util-types.ts:94](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L94)
10+
Defined in: [packages/form-core/src/util-types.ts:97](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L97)
1111

1212
## Extends
1313

@@ -29,7 +29,7 @@ Defined in: [packages/form-core/src/util-types.ts:94](https://github.com/TanStac
2929
key: ObjectAccessor<TParent, TKey>;
3030
```
3131

32-
Defined in: [packages/form-core/src/util-types.ts:99](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L99)
32+
Defined in: [packages/form-core/src/util-types.ts:102](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L102)
3333

3434
#### Overrides
3535

@@ -43,7 +43,7 @@ Defined in: [packages/form-core/src/util-types.ts:99](https://github.com/TanStac
4343
value: ObjectValue<TParent, T, TKey>;
4444
```
4545

46-
Defined in: [packages/form-core/src/util-types.ts:100](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L100)
46+
Defined in: [packages/form-core/src/util-types.ts:103](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L103)
4747

4848
#### Overrides
4949

docs/reference/interfaces/tupledeepkeyandvalue.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: TupleDeepKeyAndValue
77

88
# Interface: TupleDeepKeyAndValue\<TParent, T, TKey\>
99

10-
Defined in: [packages/form-core/src/util-types.ts:53](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L53)
10+
Defined in: [packages/form-core/src/util-types.ts:56](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L56)
1111

1212
## Extends
1313

@@ -29,7 +29,7 @@ Defined in: [packages/form-core/src/util-types.ts:53](https://github.com/TanStac
2929
key: `${TParent["key"] extends never ? "" : TParent["key"]}[${TKey}]`;
3030
```
3131

32-
Defined in: [packages/form-core/src/util-types.ts:58](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L58)
32+
Defined in: [packages/form-core/src/util-types.ts:61](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L61)
3333

3434
#### Overrides
3535

@@ -45,7 +45,7 @@ value:
4545
| Nullable<TParent["value"]>;
4646
```
4747

48-
Defined in: [packages/form-core/src/util-types.ts:59](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L59)
48+
Defined in: [packages/form-core/src/util-types.ts:62](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L62)
4949

5050
#### Overrides
5151

docs/reference/interfaces/unknowndeepkeyandvalue.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: UnknownDeepKeyAndValue
77

88
# Interface: UnknownDeepKeyAndValue\<TParent\>
99

10-
Defined in: [packages/form-core/src/util-types.ts:119](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L119)
10+
Defined in: [packages/form-core/src/util-types.ts:122](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L122)
1111

1212
## Extends
1313

@@ -25,7 +25,7 @@ Defined in: [packages/form-core/src/util-types.ts:119](https://github.com/TanSta
2525
key: UnknownAccessor<TParent>;
2626
```
2727

28-
Defined in: [packages/form-core/src/util-types.ts:121](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L121)
28+
Defined in: [packages/form-core/src/util-types.ts:124](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L124)
2929

3030
#### Overrides
3131

@@ -39,7 +39,7 @@ Defined in: [packages/form-core/src/util-types.ts:121](https://github.com/TanSta
3939
value: unknown;
4040
```
4141

42-
Defined in: [packages/form-core/src/util-types.ts:122](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L122)
42+
Defined in: [packages/form-core/src/util-types.ts:125](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L125)
4343

4444
#### Overrides
4545

docs/reference/type-aliases/allobjectkeys.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: AllObjectKeys
1111
type AllObjectKeys<T> = T extends any ? keyof T & string | number : never;
1212
```
1313

14-
Defined in: [packages/form-core/src/util-types.ts:77](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L77)
14+
Defined in: [packages/form-core/src/util-types.ts:80](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L80)
1515

1616
## Type Parameters
1717

docs/reference/type-aliases/alltuplekeys.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: AllTupleKeys
1111
type AllTupleKeys<T> = T extends any ? keyof T & `${number}` : never;
1212
```
1313

14-
Defined in: [packages/form-core/src/util-types.ts:62](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L62)
14+
Defined in: [packages/form-core/src/util-types.ts:65](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L65)
1515

1616
## Type Parameters
1717

docs/reference/type-aliases/arrayaccessor.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: ArrayAccessor
1111
type ArrayAccessor<TParent> = `${TParent["key"] extends never ? "" : TParent["key"]}[${number}]`;
1212
```
1313

14-
Defined in: [packages/form-core/src/util-types.ts:27](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L27)
14+
Defined in: [packages/form-core/src/util-types.ts:30](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L30)
1515

1616
## Type Parameters
1717

docs/reference/type-aliases/deepkeyandvaluearray.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ type DeepKeyAndValueArray<TParent, T, TAcc> = DeepKeysAndValuesImpl<NonNullable<
1313
| ArrayDeepKeyAndValue<TParent, T>>;
1414
```
1515

16-
Defined in: [packages/form-core/src/util-types.ts:38](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L38)
16+
Defined in: [packages/form-core/src/util-types.ts:41](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L41)
1717

1818
## Type Parameters
1919

docs/reference/type-aliases/deepkeyandvalueobject.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ type DeepKeyAndValueObject<TParent, T, TAcc, TAllKeys> = TAllKeys extends any ?
1313
| ObjectDeepKeyAndValue<TParent, T, TAllKeys>> : never;
1414
```
1515

16-
Defined in: [packages/form-core/src/util-types.ts:103](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L103)
16+
Defined in: [packages/form-core/src/util-types.ts:106](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L106)
1717

1818
## Type Parameters
1919

0 commit comments

Comments
 (0)