Skip to content

Commit 1399731

Browse files
ci: apply automated fixes and generate docs
1 parent 04ec648 commit 1399731

23 files changed

+150
-55
lines changed

docs/framework/lit/reference/classes/tanstackformcontroller.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Defined in: [tanstack-form-controller.ts:259](https://github.com/TanStack/form/b
8383
8484
• **TName** *extends* `string`
8585
86-
• **TData** *extends* `never`
86+
• **TData**
8787
8888
• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
8989

docs/framework/react/reference/functions/field.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The `Field` component uses the `useField` hook internally to manage the field in
2323

2424
**TName** *extends* `string`
2525

26-
**TData** *extends* `never`
26+
**TData**
2727

2828
**TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
2929

docs/framework/react/reference/functions/usefield.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ A hook for managing a field in a form.
2121

2222
**TName** *extends* `string`
2323

24-
**TData** *extends* `never`
24+
**TData**
2525

2626
**TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
2727

docs/framework/solid/reference/functions/createfield.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Defined in: [packages/solid-form/src/createField.tsx:223](https://github.com/Tan
1919

2020
**TName** *extends* `string`
2121

22-
**TData** *extends* `never`
22+
**TData**
2323

2424
**TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
2525

docs/framework/solid/reference/functions/field.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Defined in: [packages/solid-form/src/createField.tsx:524](https://github.com/Tan
1919

2020
**TName** *extends* `string`
2121

22-
**TData** *extends* `never`
22+
**TData**
2323

2424
**TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
2525

docs/framework/vue/reference/functions/usefield.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Defined in: [packages/vue-form/src/useField.tsx:267](https://github.com/TanStack
1919

2020
**TName** *extends* `string`
2121

22-
**TData** *extends* `never`
22+
**TData**
2323

2424
**TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
2525

docs/reference/classes/formapi.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ Defined in: [packages/form-core/src/FormApi.ts:727](https://github.com/TanStack/
137137
deleteField<TField>(field): void
138138
```
139139
140-
Defined in: [packages/form-core/src/FormApi.ts:1777](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1777)
140+
Defined in: [packages/form-core/src/FormApi.ts:1790](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1790)
141141
142142
#### Type Parameters
143143
@@ -161,7 +161,7 @@ Defined in: [packages/form-core/src/FormApi.ts:1777](https://github.com/TanStack
161161
getAllErrors(): object
162162
```
163163
164-
Defined in: [packages/form-core/src/FormApi.ts:2015](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2015)
164+
Defined in: [packages/form-core/src/FormApi.ts:2028](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2028)
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:1691](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1691)
215+
Defined in: [packages/form-core/src/FormApi.ts:1704](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1704)
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:1682](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1682)
241+
Defined in: [packages/form-core/src/FormApi.ts:1695](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1695)
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:1675](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1675)
267+
Defined in: [packages/form-core/src/FormApi.ts:1688](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1688)
268268
269269
Gets the value of the specified field.
270270
@@ -332,7 +332,7 @@ insertFieldValue<TField>(
332332
opts?): Promise<void>
333333
```
334334
335-
Defined in: [packages/form-core/src/FormApi.ts:1816](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1816)
335+
Defined in: [packages/form-core/src/FormApi.ts:1829](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1829)
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:1940](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1940)
393+
Defined in: [packages/form-core/src/FormApi.ts:1953](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1953)
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:2075](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2075)
436+
Defined in: [packages/form-core/src/FormApi.ts:2088](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2088)
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:2087](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2087)
470+
Defined in: [packages/form-core/src/FormApi.ts:2100](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2100)
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:1801](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1801)
503+
Defined in: [packages/form-core/src/FormApi.ts:1814](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1814)
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:1874](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1874)
540+
Defined in: [packages/form-core/src/FormApi.ts:1887](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1887)
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:1848](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1848)
578+
Defined in: [packages/form-core/src/FormApi.ts:1861](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1861)
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:1968](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1968)
649+
Defined in: [packages/form-core/src/FormApi.ts:1981](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1981)
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:1731](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1731)
675+
Defined in: [packages/form-core/src/FormApi.ts:1744](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1744)
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:1989](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1989)
701+
Defined in: [packages/form-core/src/FormApi.ts:2002](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2002)
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:1710](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1710)
723+
Defined in: [packages/form-core/src/FormApi.ts:1723](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1723)
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:1747](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1747)
756+
Defined in: [packages/form-core/src/FormApi.ts:1760](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1760)
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:1911](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1911)
794+
Defined in: [packages/form-core/src/FormApi.ts:1924](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1924)
795795

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

docs/reference/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ title: "@tanstack/form-core"
4545
- [DeepKeyAndValueTuple](type-aliases/deepkeyandvaluetuple.md)
4646
- [DeepKeys](type-aliases/deepkeys.md)
4747
- [DeepKeysAndValues](type-aliases/deepkeysandvalues.md)
48+
- [DeepKeysAndValuesImpl](type-aliases/deepkeysandvaluesimpl.md)
4849
- [DeepRecord](type-aliases/deeprecord.md)
4950
- [DeepValue](type-aliases/deepvalue.md)
5051
- [DerivedFormState](type-aliases/derivedformstate.md)
@@ -58,6 +59,7 @@ title: "@tanstack/form-core"
5859
- [FormValidator](type-aliases/formvalidator.md)
5960
- [Nullable](type-aliases/nullable.md)
6061
- [ObjectAccessor](type-aliases/objectaccessor.md)
62+
- [ObjectValue](type-aliases/objectvalue.md)
6163
- [StandardSchemaV1](type-aliases/standardschemav1.md)
6264
- [TStandardSchemaValidatorIssue](type-aliases/tstandardschemavalidatorissue.md)
6365
- [TStandardSchemaValidatorValue](type-aliases/tstandardschemavalidatorvalue.md)

docs/reference/interfaces/anydeepkeyandvalue.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@ title: AnyDeepKeyAndValue
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

12+
## Extended by
13+
14+
- [`ArrayDeepKeyAndValue`](arraydeepkeyandvalue.md)
15+
- [`TupleDeepKeyAndValue`](tupledeepkeyandvalue.md)
16+
- [`ObjectDeepKeyAndValue`](objectdeepkeyandvalue.md)
17+
- [`UnknownDeepKeyAndValue`](unknowndeepkeyandvalue.md)
18+
1219
## Properties
1320

1421
### key

docs/reference/interfaces/arraydeepkeyandvalue.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ title: ArrayDeepKeyAndValue
99

1010
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)
1111

12+
## Extends
13+
14+
- [`AnyDeepKeyAndValue`](anydeepkeyandvalue.md)
15+
1216
## Type Parameters
1317

1418
**TParent** *extends* [`AnyDeepKeyAndValue`](anydeepkeyandvalue.md)
@@ -25,6 +29,10 @@ key: `${TParent["key"] extends never ? "" : TParent["key"]}[${number}]`;
2529

2630
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)
2731

32+
#### Overrides
33+
34+
[`AnyDeepKeyAndValue`](anydeepkeyandvalue.md).[`key`](AnyDeepKeyAndValue.md#key)
35+
2836
***
2937

3038
### value
@@ -36,3 +44,7 @@ value:
3644
```
3745

3846
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)
47+
48+
#### Overrides
49+
50+
[`AnyDeepKeyAndValue`](anydeepkeyandvalue.md).[`value`](AnyDeepKeyAndValue.md#value)

docs/reference/interfaces/objectdeepkeyandvalue.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@ title: ObjectDeepKeyAndValue
77

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

10-
Defined in: [packages/form-core/src/util-types.ts:88](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L88)
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)
11+
12+
## Extends
13+
14+
- [`AnyDeepKeyAndValue`](anydeepkeyandvalue.md)
1115

1216
## Type Parameters
1317

@@ -25,16 +29,22 @@ Defined in: [packages/form-core/src/util-types.ts:88](https://github.com/TanStac
2529
key: ObjectAccessor<TParent, TKey>;
2630
```
2731

28-
Defined in: [packages/form-core/src/util-types.ts:93](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L93)
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)
33+
34+
#### Overrides
35+
36+
[`AnyDeepKeyAndValue`](anydeepkeyandvalue.md).[`key`](AnyDeepKeyAndValue.md#key)
2937

3038
***
3139

3240
### value
3341

3442
```ts
35-
value:
36-
| T[TKey]
37-
| Nullable<TParent["value"]>;
43+
value: ObjectValue<TParent, T, TKey>;
3844
```
3945

40-
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)
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)
47+
48+
#### Overrides
49+
50+
[`AnyDeepKeyAndValue`](anydeepkeyandvalue.md).[`value`](AnyDeepKeyAndValue.md#value)

docs/reference/interfaces/tupledeepkeyandvalue.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ title: TupleDeepKeyAndValue
99

1010
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)
1111

12+
## Extends
13+
14+
- [`AnyDeepKeyAndValue`](anydeepkeyandvalue.md)
15+
1216
## Type Parameters
1317

1418
**TParent** *extends* [`AnyDeepKeyAndValue`](anydeepkeyandvalue.md)
@@ -27,6 +31,10 @@ key: `${TParent["key"] extends never ? "" : TParent["key"]}[${TKey}]`;
2731

2832
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)
2933

34+
#### Overrides
35+
36+
[`AnyDeepKeyAndValue`](anydeepkeyandvalue.md).[`key`](AnyDeepKeyAndValue.md#key)
37+
3038
***
3139

3240
### value
@@ -38,3 +46,7 @@ value:
3846
```
3947

4048
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)
49+
50+
#### Overrides
51+
52+
[`AnyDeepKeyAndValue`](anydeepkeyandvalue.md).[`value`](AnyDeepKeyAndValue.md#value)

docs/reference/interfaces/unknowndeepkeyandvalue.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@ title: UnknownDeepKeyAndValue
77

88
# Interface: UnknownDeepKeyAndValue\<TParent\>
99

10-
Defined in: [packages/form-core/src/util-types.ts:113](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L113)
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)
11+
12+
## Extends
13+
14+
- [`AnyDeepKeyAndValue`](anydeepkeyandvalue.md)
1115

1216
## Type Parameters
1317

@@ -21,7 +25,11 @@ Defined in: [packages/form-core/src/util-types.ts:113](https://github.com/TanSta
2125
key: UnknownAccessor<TParent>;
2226
```
2327

24-
Defined in: [packages/form-core/src/util-types.ts:114](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L114)
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)
29+
30+
#### Overrides
31+
32+
[`AnyDeepKeyAndValue`](anydeepkeyandvalue.md).[`key`](AnyDeepKeyAndValue.md#key)
2533

2634
***
2735

@@ -31,4 +39,8 @@ Defined in: [packages/form-core/src/util-types.ts:114](https://github.com/TanSta
3139
value: unknown;
3240
```
3341

34-
Defined in: [packages/form-core/src/util-types.ts:115](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L115)
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)
43+
44+
#### Overrides
45+
46+
[`AnyDeepKeyAndValue`](anydeepkeyandvalue.md).[`value`](AnyDeepKeyAndValue.md#value)

docs/reference/type-aliases/deepkeyandvaluearray.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ title: DeepKeyAndValueArray
88
# Type Alias: DeepKeyAndValueArray\<TParent, T, TAcc\>
99

1010
```ts
11-
type DeepKeyAndValueArray<TParent, T, TAcc> = DeepKeysAndValues<NonNullable<T[number]>, ArrayDeepKeyAndValue<TParent, T>,
11+
type DeepKeyAndValueArray<TParent, T, TAcc> = DeepKeysAndValuesImpl<NonNullable<T[number]>, ArrayDeepKeyAndValue<TParent, T>,
1212
| TAcc
1313
| ArrayDeepKeyAndValue<TParent, T>>;
1414
```

0 commit comments

Comments
 (0)