Skip to content

Commit 1264aab

Browse files
autofix-ci[bot]autofix-ci[bot]
authored
ci: apply automated fixes and generate docs
1 parent 5d2c8dd commit 1264aab

26 files changed

+372
-126
lines changed

‎docs/reference/classes/formapi.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@ Defined in: [packages/form-core/src/FormApi.ts:1816](https://github.com/TanStack
350350
351351
##### value
352352
353-
[`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`\> *extends* `any`[] ? [`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`\>\[`number`\] : `never`
353+
[`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`\>\[`number`\] : `never`
354354
355355
##### opts?
356356
@@ -447,7 +447,7 @@ Pushes a value into an array field.
447447
448448
##### value
449449
450-
[`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`\> *extends* `any`[] ? [`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`\>\[`number`\] : `never`
450+
[`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`\>\[`number`\] : `never`
451451
452452
##### opts?
453453
@@ -526,7 +526,7 @@ Replaces a value into an array field at the specified index.
526526
527527
##### value
528528
529-
[`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`\> *extends* `any`[] ? [`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`\>\[`number`\] : `never`
529+
[`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`\>\[`number`\] : `never`
530530
531531
##### opts?
532532

‎docs/reference/index.md

+12-4
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,19 @@ title: "@tanstack/form-core"
1414

1515
## Interfaces
1616

17+
- [AnyDeepKeyAndValue](interfaces/anydeepkeyandvalue.md)
18+
- [ArrayDeepKeyAndValue](interfaces/arraydeepkeyandvalue.md)
1719
- [FieldApiOptions](interfaces/fieldapioptions.md)
1820
- [FieldListeners](interfaces/fieldlisteners.md)
1921
- [FieldOptions](interfaces/fieldoptions.md)
2022
- [FieldValidators](interfaces/fieldvalidators.md)
2123
- [FormOptions](interfaces/formoptions.md)
2224
- [FormState](interfaces/formstate.md)
2325
- [FormValidators](interfaces/formvalidators.md)
26+
- [ObjectDeepKeyAndValue](interfaces/objectdeepkeyandvalue.md)
2427
- [StandardSchemaV1Issue](interfaces/standardschemav1issue.md)
28+
- [TupleDeepKeyAndValue](interfaces/tupledeepkeyandvalue.md)
29+
- [UnknownDeepKeyAndValue](interfaces/unknowndeepkeyandvalue.md)
2530

2631
## Type Aliases
2732

@@ -35,12 +40,13 @@ title: "@tanstack/form-core"
3540
- [AnyFormState](type-aliases/anyformstate.md)
3641
- [ArrayAccessor](type-aliases/arrayaccessor.md)
3742
- [BaseFormState](type-aliases/baseformstate.md)
43+
- [DeepKeyAndValueArray](type-aliases/deepkeyandvaluearray.md)
44+
- [DeepKeyAndValueObject](type-aliases/deepkeyandvalueobject.md)
45+
- [DeepKeyAndValueTuple](type-aliases/deepkeyandvaluetuple.md)
46+
- [DeepKeyAndValueUnknown](type-aliases/deepkeyandvalueunknown.md)
3847
- [DeepKeys](type-aliases/deepkeys.md)
48+
- [DeepKeysAndValues](type-aliases/deepkeysandvalues.md)
3949
- [DeepRecord](type-aliases/deeprecord.md)
40-
- [DeepRecordArrayUnion](type-aliases/deeprecordarrayunion.md)
41-
- [DeepRecordObjectUnion](type-aliases/deeprecordobjectunion.md)
42-
- [DeepRecordTupleUnion](type-aliases/deeprecordtupleunion.md)
43-
- [DeepRecordUnion](type-aliases/deeprecordunion.md)
4450
- [DeepValue](type-aliases/deepvalue.md)
4551
- [DerivedFormState](type-aliases/derivedformstate.md)
4652
- [FieldInfo](type-aliases/fieldinfo.md)
@@ -51,10 +57,12 @@ title: "@tanstack/form-core"
5157
- [FormValidateFn](type-aliases/formvalidatefn.md)
5258
- [FormValidationError](type-aliases/formvalidationerror.md)
5359
- [FormValidator](type-aliases/formvalidator.md)
60+
- [Nullable](type-aliases/nullable.md)
5461
- [ObjectAccessor](type-aliases/objectaccessor.md)
5562
- [StandardSchemaV1](type-aliases/standardschemav1.md)
5663
- [TStandardSchemaValidatorValue](type-aliases/tstandardschemavalidatorvalue.md)
5764
- [TupleAccessor](type-aliases/tupleaccessor.md)
65+
- [UnknownAccessor](type-aliases/unknownaccessor.md)
5866
- [UnwrapFieldAsyncValidateOrFn](type-aliases/unwrapfieldasyncvalidateorfn.md)
5967
- [UnwrapFieldValidateOrFn](type-aliases/unwrapfieldvalidateorfn.md)
6068
- [UnwrapFormAsyncValidateOrFn](type-aliases/unwrapformasyncvalidateorfn.md)

‎docs/reference/interfaces/anydeepkeyandvalue.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
id: AnyDeepKeyAndValue
3+
title: AnyDeepKeyAndValue
4+
---
5+
6+
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7+
8+
# Interface: AnyDeepKeyAndValue
9+
10+
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)
11+
12+
## Properties
13+
14+
### key
15+
16+
```ts
17+
key: string;
18+
```
19+
20+
Defined in: [packages/form-core/src/util-types.ts:25](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L25)
21+
22+
***
23+
24+
### value
25+
26+
```ts
27+
value: any;
28+
```
29+
30+
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)

‎docs/reference/interfaces/arraydeepkeyandvalue.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
id: ArrayDeepKeyAndValue
3+
title: ArrayDeepKeyAndValue
4+
---
5+
6+
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7+
8+
# Interface: ArrayDeepKeyAndValue\<TParent, T\>
9+
10+
Defined in: [packages/form-core/src/util-types.ts:32](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L32)
11+
12+
## Type Parameters
13+
14+
• **TParent** *extends* [`AnyDeepKeyAndValue`](anydeepkeyandvalue.md)
15+
16+
• **T** *extends* `ReadonlyArray`\<`any`\>
17+
18+
## Properties
19+
20+
### key
21+
22+
```ts
23+
key: `${TParent["key"] extends never ? "" : TParent["key"]}[${number}]`;
24+
```
25+
26+
Defined in: [packages/form-core/src/util-types.ts:36](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L36)
27+
28+
***
29+
30+
### value
31+
32+
```ts
33+
value:
34+
| T[number]
35+
| Nullable<TParent["value"]>;
36+
```
37+
38+
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)

‎docs/reference/interfaces/objectdeepkeyandvalue.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
id: ObjectDeepKeyAndValue
3+
title: ObjectDeepKeyAndValue
4+
---
5+
6+
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7+
8+
# Interface: ObjectDeepKeyAndValue\<TParent, T, TKey\>
9+
10+
Defined in: [packages/form-core/src/util-types.ts:90](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L90)
11+
12+
## Type Parameters
13+
14+
• **TParent** *extends* [`AnyDeepKeyAndValue`](anydeepkeyandvalue.md)
15+
16+
• **T**
17+
18+
• **TKey** *extends* [`AllObjectKeys`](../type-aliases/allobjectkeys.md)\<`T`\>
19+
20+
## Properties
21+
22+
### key
23+
24+
```ts
25+
key: ObjectAccessor<TParent, TKey>;
26+
```
27+
28+
Defined in: [packages/form-core/src/util-types.ts:95](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L95)
29+
30+
***
31+
32+
### value
33+
34+
```ts
35+
value:
36+
| T[TKey]
37+
| Nullable<TParent["value"]>;
38+
```
39+
40+
Defined in: [packages/form-core/src/util-types.ts:96](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L96)

‎docs/reference/interfaces/tupledeepkeyandvalue.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
id: TupleDeepKeyAndValue
3+
title: TupleDeepKeyAndValue
4+
---
5+
6+
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7+
8+
# Interface: TupleDeepKeyAndValue\<TParent, T, TKey\>
9+
10+
Defined in: [packages/form-core/src/util-types.ts:55](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L55)
11+
12+
## Type Parameters
13+
14+
• **TParent** *extends* [`AnyDeepKeyAndValue`](anydeepkeyandvalue.md)
15+
16+
• **T**
17+
18+
• **TKey** *extends* [`AllTupleKeys`](../type-aliases/alltuplekeys.md)\<`T`\>
19+
20+
## Properties
21+
22+
### key
23+
24+
```ts
25+
key: `${TParent["key"] extends never ? "" : TParent["key"]}[${TKey}]`;
26+
```
27+
28+
Defined in: [packages/form-core/src/util-types.ts:60](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L60)
29+
30+
***
31+
32+
### value
33+
34+
```ts
35+
value:
36+
| T[TKey]
37+
| Nullable<TParent["value"]>;
38+
```
39+
40+
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)

‎docs/reference/interfaces/unknowndeepkeyandvalue.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
id: UnknownDeepKeyAndValue
3+
title: UnknownDeepKeyAndValue
4+
---
5+
6+
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7+
8+
# Interface: UnknownDeepKeyAndValue\<TParent\>
9+
10+
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)
11+
12+
## Type Parameters
13+
14+
• **TParent** *extends* [`AnyDeepKeyAndValue`](anydeepkeyandvalue.md)
15+
16+
## Properties
17+
18+
### key
19+
20+
```ts
21+
key: UnknownAccessor<TParent>;
22+
```
23+
24+
Defined in: [packages/form-core/src/util-types.ts:116](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L116)
25+
26+
***
27+
28+
### value
29+
30+
```ts
31+
value: unknown;
32+
```
33+
34+
Defined in: [packages/form-core/src/util-types.ts:117](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L117)

‎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:56](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L56)
14+
Defined in: [packages/form-core/src/util-types.ts:79](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L79)
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:41](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L41)
14+
Defined in: [packages/form-core/src/util-types.ts:64](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L64)
1515

1616
## Type Parameters
1717

‎docs/reference/type-aliases/arrayaccessor.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ title: ArrayAccessor
55

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

8-
# Type Alias: ArrayAccessor\<TPrefix\>
8+
# Type Alias: ArrayAccessor\<TParent\>
99

1010
```ts
11-
type ArrayAccessor<TPrefix> = `${TPrefix}[${number}]`;
11+
type ArrayAccessor<TParent> = `${TParent["key"] extends never ? "" : TParent["key"]}[${number}]`;
1212
```
1313

14-
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)
14+
Defined in: [packages/form-core/src/util-types.ts:29](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L29)
1515

1616
## Type Parameters
1717

18-
• **TPrefix** *extends* `string`
18+
• **TParent** *extends* [`AnyDeepKeyAndValue`](../interfaces/anydeepkeyandvalue.md)

‎docs/reference/type-aliases/deepkeyandvaluearray.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
id: DeepKeyAndValueArray
3+
title: DeepKeyAndValueArray
4+
---
5+
6+
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7+
8+
# Type Alias: DeepKeyAndValueArray\<TParent, T, TAcc\>
9+
10+
```ts
11+
type DeepKeyAndValueArray<TParent, T, TAcc> = DeepKeysAndValues<NonNullable<T[number]>, ArrayDeepKeyAndValue<TParent, T>,
12+
| TAcc
13+
| ArrayDeepKeyAndValue<TParent, T>>;
14+
```
15+
16+
Defined in: [packages/form-core/src/util-types.ts:40](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L40)
17+
18+
## Type Parameters
19+
20+
• **TParent** *extends* [`AnyDeepKeyAndValue`](../interfaces/anydeepkeyandvalue.md)
21+
22+
• **T** *extends* `ReadonlyArray`\<`any`\>
23+
24+
• **TAcc**

‎docs/reference/type-aliases/deepkeyandvalueobject.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
id: DeepKeyAndValueObject
3+
title: DeepKeyAndValueObject
4+
---
5+
6+
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7+
8+
# Type Alias: DeepKeyAndValueObject\<TParent, T, TAcc, TAllKeys\>
9+
10+
```ts
11+
type DeepKeyAndValueObject<TParent, T, TAcc, TAllKeys> = TAllKeys extends any ? DeepKeysAndValues<NonNullable<T[TAllKeys]>, ObjectDeepKeyAndValue<TParent, T, TAllKeys>,
12+
| TAcc
13+
| ObjectDeepKeyAndValue<TParent, T, TAllKeys>> : never;
14+
```
15+
16+
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)
17+
18+
## Type Parameters
19+
20+
• **TParent** *extends* [`AnyDeepKeyAndValue`](../interfaces/anydeepkeyandvalue.md)
21+
22+
• **T**
23+
24+
• **TAcc**
25+
26+
• **TAllKeys** *extends* [`AllObjectKeys`](allobjectkeys.md)\<`T`\> = [`AllObjectKeys`](allobjectkeys.md)\<`T`\>

‎docs/reference/type-aliases/deepkeyandvaluetuple.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
id: DeepKeyAndValueTuple
3+
title: DeepKeyAndValueTuple
4+
---
5+
6+
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7+
8+
# Type Alias: DeepKeyAndValueTuple\<TParent, T, TAcc, TAllKeys\>
9+
10+
```ts
11+
type DeepKeyAndValueTuple<TParent, T, TAcc, TAllKeys> = TAllKeys extends any ? DeepKeysAndValues<NonNullable<T[TAllKeys]>, TupleDeepKeyAndValue<TParent, T, TAllKeys>,
12+
| TAcc
13+
| TupleDeepKeyAndValue<TParent, T, TAllKeys>> : never;
14+
```
15+
16+
Defined in: [packages/form-core/src/util-types.ts:66](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L66)
17+
18+
## Type Parameters
19+
20+
• **TParent** *extends* [`AnyDeepKeyAndValue`](../interfaces/anydeepkeyandvalue.md)
21+
22+
• **T** *extends* `ReadonlyArray`\<`any`\>
23+
24+
• **TAcc**
25+
26+
• **TAllKeys** *extends* [`AllTupleKeys`](alltuplekeys.md)\<`T`\> = [`AllTupleKeys`](alltuplekeys.md)\<`T`\>

‎docs/reference/type-aliases/deepkeyandvalueunknown.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
id: DeepKeyAndValueUnknown
3+
title: DeepKeyAndValueUnknown
4+
---
5+
6+
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7+
8+
# Type Alias: DeepKeyAndValueUnknown\<TParent\>
9+
10+
```ts
11+
type DeepKeyAndValueUnknown<TParent> = UnknownDeepKeyAndValue<TParent>;
12+
```
13+
14+
Defined in: [packages/form-core/src/util-types.ts:120](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L120)
15+
16+
## Type Parameters
17+
18+
• **TParent** *extends* [`AnyDeepKeyAndValue`](../interfaces/anydeepkeyandvalue.md)

0 commit comments

Comments
 (0)