Skip to content

Commit a56d353

Browse files
fix: useStore without a selector should no longer crash in React (#1123)
* fix: useStore without a selector should no longer crash in React * ci: apply automated fixes and generate docs --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
1 parent 280060a commit a56d353

16 files changed

+204
-65
lines changed

docs/reference/classes/formapi.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: FormApi
55

66
# Class: FormApi\<TFormData, TFormValidator\>
77

8-
Defined in: [packages/form-core/src/FormApi.ts:360](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L360)
8+
Defined in: [packages/form-core/src/FormApi.ts:361](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L361)
99

1010
A class representing the Form API. It handles the logic and interactions with the form state.
1111

@@ -27,7 +27,7 @@ However, if you need to create a new instance manually, you can do so by calling
2727
new FormApi<TFormData, TFormValidator>(opts?): FormApi<TFormData, TFormValidator>
2828
```
2929
30-
Defined in: [packages/form-core/src/FormApi.ts:389](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L389)
30+
Defined in: [packages/form-core/src/FormApi.ts:390](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L390)
3131
3232
Constructs a new `FormApi` instance with the given form options.
3333
@@ -49,7 +49,7 @@ Constructs a new `FormApi` instance with the given form options.
4949
baseStore: Store<BaseFormState<TFormData>, (cb) => BaseFormState<TFormData>>;
5050
```
5151
52-
Defined in: [packages/form-core/src/FormApi.ts:368](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L368)
52+
Defined in: [packages/form-core/src/FormApi.ts:369](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L369)
5353
5454
***
5555
@@ -59,7 +59,7 @@ Defined in: [packages/form-core/src/FormApi.ts:368](https://github.com/TanStack/
5959
fieldInfo: Record<unknown extends TFormData ? string : TFormData extends readonly any[] & IsTuple<TFormData> ? PrefixTupleAccessor<TFormData<TFormData>, AllowedIndexes<TFormData<TFormData>, never>, []> : TFormData extends any[] ? PrefixArrayAccessor<TFormData<TFormData>, [any]> : TFormData extends Date ? never : TFormData extends object ? PrefixObjectAccessor<TFormData<TFormData>, []> : TFormData extends string | number | bigint | boolean ? "" : never, FieldInfo<TFormData, TFormValidator>>;
6060
```
6161
62-
Defined in: [packages/form-core/src/FormApi.ts:374](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L374)
62+
Defined in: [packages/form-core/src/FormApi.ts:375](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L375)
6363
6464
A record of field information for each field in the form.
6565
@@ -71,7 +71,7 @@ A record of field information for each field in the form.
7171
fieldMetaDerived: Derived<Record<unknown extends TFormData ? string : TFormData extends readonly any[] & IsTuple<TFormData> ? PrefixTupleAccessor<TFormData<TFormData>, AllowedIndexes<TFormData<TFormData>, never>, []> : TFormData extends any[] ? PrefixArrayAccessor<TFormData<TFormData>, [any]> : TFormData extends Date ? never : TFormData extends object ? PrefixObjectAccessor<TFormData<TFormData>, []> : TFormData extends string | number | bigint | boolean ? "" : never, FieldMeta>>;
7272
```
7373
74-
Defined in: [packages/form-core/src/FormApi.ts:369](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L369)
74+
Defined in: [packages/form-core/src/FormApi.ts:370](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L370)
7575
7676
***
7777
@@ -81,7 +81,7 @@ Defined in: [packages/form-core/src/FormApi.ts:369](https://github.com/TanStack/
8181
options: FormOptions<TFormData, TFormValidator> = {};
8282
```
8383
84-
Defined in: [packages/form-core/src/FormApi.ts:367](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L367)
84+
Defined in: [packages/form-core/src/FormApi.ts:368](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L368)
8585
8686
The options for the form.
8787
@@ -93,7 +93,7 @@ The options for the form.
9393
store: Derived<FormState<TFormData>>;
9494
```
9595
96-
Defined in: [packages/form-core/src/FormApi.ts:370](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L370)
96+
Defined in: [packages/form-core/src/FormApi.ts:371](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L371)
9797
9898
## Accessors
9999
@@ -105,7 +105,7 @@ Defined in: [packages/form-core/src/FormApi.ts:370](https://github.com/TanStack/
105105
get state(): FormState<TFormData>
106106
```
107107
108-
Defined in: [packages/form-core/src/FormApi.ts:377](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L377)
108+
Defined in: [packages/form-core/src/FormApi.ts:378](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L378)
109109
110110
##### Returns
111111
@@ -119,7 +119,7 @@ Defined in: [packages/form-core/src/FormApi.ts:377](https://github.com/TanStack/
119119
deleteField<TField>(field): void
120120
```
121121
122-
Defined in: [packages/form-core/src/FormApi.ts:1194](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1194)
122+
Defined in: [packages/form-core/src/FormApi.ts:1227](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1227)
123123
124124
#### Type Parameters
125125
@@ -143,7 +143,7 @@ Defined in: [packages/form-core/src/FormApi.ts:1194](https://github.com/TanStack
143143
getFieldInfo<TField>(field): FieldInfo<TFormData, TFormValidator>
144144
```
145145
146-
Defined in: [packages/form-core/src/FormApi.ts:1103](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1103)
146+
Defined in: [packages/form-core/src/FormApi.ts:1136](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1136)
147147
148148
Gets the field info of the specified field.
149149
@@ -169,7 +169,7 @@ Gets the field info of the specified field.
169169
getFieldMeta<TField>(field): undefined | FieldMeta
170170
```
171171
172-
Defined in: [packages/form-core/src/FormApi.ts:1094](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1094)
172+
Defined in: [packages/form-core/src/FormApi.ts:1127](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1127)
173173
174174
Gets the metadata of the specified field.
175175
@@ -195,7 +195,7 @@ Gets the metadata of the specified field.
195195
getFieldValue<TField>(field): DeepValue<TFormData, TField, IsNullable<TFormData>>
196196
```
197197
198-
Defined in: [packages/form-core/src/FormApi.ts:1087](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1087)
198+
Defined in: [packages/form-core/src/FormApi.ts:1120](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1120)
199199
200200
Gets the value of the specified field.
201201
@@ -221,7 +221,7 @@ Gets the value of the specified field.
221221
handleSubmit(): Promise<void>
222222
```
223223
224-
Defined in: [packages/form-core/src/FormApi.ts:1028](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1028)
224+
Defined in: [packages/form-core/src/FormApi.ts:1061](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1061)
225225
226226
Handles the form submission, performs validation, and calls the appropriate onSubmit or onInvalidSubmit callbacks.
227227
@@ -241,7 +241,7 @@ insertFieldValue<TField>(
241241
opts?): Promise<void>
242242
```
243243
244-
Defined in: [packages/form-core/src/FormApi.ts:1226](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1226)
244+
Defined in: [packages/form-core/src/FormApi.ts:1259](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1259)
245245
246246
Inserts a value into an array field at the specified index, shifting the subsequent values to the right.
247247
@@ -279,7 +279,7 @@ Inserts a value into an array field at the specified index, shifting the subsequ
279279
mount(): () => void
280280
```
281281
282-
Defined in: [packages/form-core/src/FormApi.ts:607](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L607)
282+
Defined in: [packages/form-core/src/FormApi.ts:638](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L638)
283283
284284
#### Returns
285285
@@ -301,7 +301,7 @@ moveFieldValues<TField>(
301301
opts?): void
302302
```
303303
304-
Defined in: [packages/form-core/src/FormApi.ts:1344](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1344)
304+
Defined in: [packages/form-core/src/FormApi.ts:1377](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1377)
305305
306306
Moves the value at the first specified index to the second specified index within an array field.
307307
@@ -342,7 +342,7 @@ pushFieldValue<TField>(
342342
opts?): void
343343
```
344344
345-
Defined in: [packages/form-core/src/FormApi.ts:1208](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1208)
345+
Defined in: [packages/form-core/src/FormApi.ts:1241](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1241)
346346
347347
Pushes a value into an array field.
348348
@@ -379,7 +379,7 @@ removeFieldValue<TField>(
379379
opts?): Promise<void>
380380
```
381381
382-
Defined in: [packages/form-core/src/FormApi.ts:1279](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1279)
382+
Defined in: [packages/form-core/src/FormApi.ts:1312](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1312)
383383
384384
Removes a value from an array field at the specified index.
385385
@@ -417,7 +417,7 @@ replaceFieldValue<TField>(
417417
opts?): Promise<void>
418418
```
419419
420-
Defined in: [packages/form-core/src/FormApi.ts:1253](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1253)
420+
Defined in: [packages/form-core/src/FormApi.ts:1286](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1286)
421421
422422
Replaces a value into an array field at the specified index.
423423
@@ -455,7 +455,7 @@ Replaces a value into an array field at the specified index.
455455
reset(values?, opts?): void
456456
```
457457
458-
Defined in: [packages/form-core/src/FormApi.ts:668](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L668)
458+
Defined in: [packages/form-core/src/FormApi.ts:701](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L701)
459459
460460
Resets the form state to the default values.
461461
If values are provided, the form will be reset to those values instead and the default values will be updated.
@@ -488,7 +488,7 @@ Optional options to control the reset behavior.
488488
resetFieldMeta<TField>(fieldMeta): Record<TField, FieldMeta>
489489
```
490490
491-
Defined in: [packages/form-core/src/FormApi.ts:1140](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1140)
491+
Defined in: [packages/form-core/src/FormApi.ts:1173](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1173)
492492
493493
#### Type Parameters
494494
@@ -512,7 +512,7 @@ Defined in: [packages/form-core/src/FormApi.ts:1140](https://github.com/TanStack
512512
setErrorMap(errorMap): void
513513
```
514514
515-
Defined in: [packages/form-core/src/FormApi.ts:1368](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1368)
515+
Defined in: [packages/form-core/src/FormApi.ts:1401](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1401)
516516
517517
Updates the form's errorMap
518518
@@ -534,7 +534,7 @@ Updates the form's errorMap
534534
setFieldMeta<TField>(field, updater): void
535535
```
536536
537-
Defined in: [packages/form-core/src/FormApi.ts:1122](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1122)
537+
Defined in: [packages/form-core/src/FormApi.ts:1155](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1155)
538538
539539
Updates the metadata of the specified field.
540540
@@ -567,7 +567,7 @@ setFieldValue<TField>(
567567
opts?): void
568568
```
569569
570-
Defined in: [packages/form-core/src/FormApi.ts:1164](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1164)
570+
Defined in: [packages/form-core/src/FormApi.ts:1197](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1197)
571571
572572
Sets the value of the specified field and optionally updates the touched state.
573573
@@ -605,7 +605,7 @@ swapFieldValues<TField>(
605605
opts?): void
606606
```
607607
608-
Defined in: [packages/form-core/src/FormApi.ts:1318](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1318)
608+
Defined in: [packages/form-core/src/FormApi.ts:1351](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1351)
609609
610610
Swaps the values at the specified indices within an array field.
611611
@@ -643,7 +643,7 @@ Swaps the values at the specified indices within an array field.
643643
update(options?): void
644644
```
645645
646-
Defined in: [packages/form-core/src/FormApi.ts:624](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L624)
646+
Defined in: [packages/form-core/src/FormApi.ts:655](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L655)
647647
648648
Updates the form options and form state.
649649
@@ -665,7 +665,7 @@ Updates the form options and form state.
665665
validateAllFields(cause): Promise<ValidationError[]>
666666
```
667667
668-
Defined in: [packages/form-core/src/FormApi.ts:694](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L694)
668+
Defined in: [packages/form-core/src/FormApi.ts:727](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L727)
669669
670670
Validates form and all fields in using the correct handlers for a given validation cause.
671671
@@ -690,7 +690,7 @@ validateArrayFieldsStartingFrom<TField>(
690690
cause): Promise<ValidationError[]>
691691
```
692692
693-
Defined in: [packages/form-core/src/FormApi.ts:722](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L722)
693+
Defined in: [packages/form-core/src/FormApi.ts:755](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L755)
694694
695695
Validates the children of a specified array in the form starting from a given index until the end using the correct handlers for a given validation type.
696696
@@ -726,7 +726,7 @@ validateField<TField>(field, cause):
726726
| Promise<ValidationError[]>
727727
```
728728
729-
Defined in: [packages/form-core/src/FormApi.ts:761](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L761)
729+
Defined in: [packages/form-core/src/FormApi.ts:794](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L794)
730730
731731
Validates a specified field in the form using the correct handlers for a given validation type.
732732

docs/reference/functions/shallow.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
id: shallow
3+
title: shallow
4+
---
5+
6+
# Function: shallow()
7+
8+
```ts
9+
function shallow<T>(objA, objB): boolean
10+
```
11+
12+
Defined in: [packages/form-core/src/utils.ts:328](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L328)
13+
14+
## Type Parameters
15+
16+
**T**
17+
18+
## Parameters
19+
20+
### objA
21+
22+
`T`
23+
24+
### objB
25+
26+
`T`
27+
28+
## Returns
29+
30+
`boolean`

docs/reference/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,5 @@ title: "@tanstack/form-core"
4646
- [formOptions](functions/formoptions.md)
4747
- [isStandardSchemaValidator](functions/isstandardschemavalidator.md)
4848
- [mergeForm](functions/mergeform.md)
49+
- [shallow](functions/shallow.md)
4950
- [standardSchemaValidator](functions/standardschemavalidator.md)

docs/reference/interfaces/formoptions.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: FormOptions
55

66
# Interface: FormOptions\<TFormData, TFormValidator\>
77

8-
Defined in: [packages/form-core/src/FormApi.ts:148](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L148)
8+
Defined in: [packages/form-core/src/FormApi.ts:149](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L149)
99

1010
An object representing the options for a form.
1111

@@ -23,7 +23,7 @@ An object representing the options for a form.
2323
optional asyncAlways: boolean;
2424
```
2525

26-
Defined in: [packages/form-core/src/FormApi.ts:163](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L163)
26+
Defined in: [packages/form-core/src/FormApi.ts:164](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L164)
2727

2828
If true, always run async validation, even when sync validation has produced an error. Defaults to undefined.
2929

@@ -35,7 +35,7 @@ If true, always run async validation, even when sync validation has produced an
3535
optional asyncDebounceMs: number;
3636
```
3737

38-
Defined in: [packages/form-core/src/FormApi.ts:167](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L167)
38+
Defined in: [packages/form-core/src/FormApi.ts:168](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L168)
3939

4040
Optional time in milliseconds if you want to introduce a delay before firing off an async action.
4141

@@ -47,7 +47,7 @@ Optional time in milliseconds if you want to introduce a delay before firing off
4747
optional defaultState: Partial<FormState<TFormData>>;
4848
```
4949

50-
Defined in: [packages/form-core/src/FormApi.ts:159](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L159)
50+
Defined in: [packages/form-core/src/FormApi.ts:160](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L160)
5151

5252
The default state for the form.
5353

@@ -59,7 +59,7 @@ The default state for the form.
5959
optional defaultValues: TFormData;
6060
```
6161

62-
Defined in: [packages/form-core/src/FormApi.ts:155](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L155)
62+
Defined in: [packages/form-core/src/FormApi.ts:156](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L156)
6363

6464
Set initial values for your form.
6565

@@ -71,7 +71,7 @@ Set initial values for your form.
7171
optional onSubmit: (props) => any;
7272
```
7373

74-
Defined in: [packages/form-core/src/FormApi.ts:179](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L179)
74+
Defined in: [packages/form-core/src/FormApi.ts:180](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L180)
7575

7676
A function to be called when the form is submitted, what should happen once the user submits a valid form returns `any` or a promise `Promise<any>`
7777

@@ -99,7 +99,7 @@ A function to be called when the form is submitted, what should happen once the
9999
optional onSubmitInvalid: (props) => void;
100100
```
101101

102-
Defined in: [packages/form-core/src/FormApi.ts:186](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L186)
102+
Defined in: [packages/form-core/src/FormApi.ts:187](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L187)
103103

104104
Specify an action for scenarios where the user tries to submit an invalid form.
105105

@@ -127,7 +127,7 @@ Specify an action for scenarios where the user tries to submit an invalid form.
127127
optional transform: FormTransform<TFormData, TFormValidator>;
128128
```
129129

130-
Defined in: [packages/form-core/src/FormApi.ts:190](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L190)
130+
Defined in: [packages/form-core/src/FormApi.ts:191](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L191)
131131

132132
***
133133

@@ -137,7 +137,7 @@ Defined in: [packages/form-core/src/FormApi.ts:190](https://github.com/TanStack/
137137
optional validatorAdapter: TFormValidator;
138138
```
139139

140-
Defined in: [packages/form-core/src/FormApi.ts:171](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L171)
140+
Defined in: [packages/form-core/src/FormApi.ts:172](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L172)
141141

142142
A validator adapter to support usage of extra validation types (IE: Zod, Yup, or Valibot usage)
143143

@@ -149,6 +149,6 @@ A validator adapter to support usage of extra validation types (IE: Zod, Yup, or
149149
optional validators: FormValidators<TFormData, TFormValidator>;
150150
```
151151

152-
Defined in: [packages/form-core/src/FormApi.ts:175](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L175)
152+
Defined in: [packages/form-core/src/FormApi.ts:176](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L176)
153153

154154
A list of validators to pass to the form

0 commit comments

Comments
 (0)