Skip to content

Commit d0e8ad3

Browse files
ci: apply automated fixes and generate docs
1 parent 67dde9f commit d0e8ad3

File tree

4 files changed

+40
-40
lines changed

4 files changed

+40
-40
lines changed

docs/reference/classes/formapi.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ However, if you need to create a new instance manually, you can do so by calling
5353
new FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>(opts?): FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>
5454
```
5555
56-
Defined in: [packages/form-core/src/FormApi.ts:977](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L977)
56+
Defined in: [packages/form-core/src/FormApi.ts:991](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L991)
5757
5858
Constructs a new `FormApi` instance with the given form options.
5959
@@ -85,7 +85,7 @@ Defined in: [packages/form-core/src/FormApi.ts:912](https://github.com/TanStack/
8585
fieldInfo: Record<DeepKeys<TFormData>, FieldInfo<TFormData>>;
8686
```
8787
88-
Defined in: [packages/form-core/src/FormApi.ts:946](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L946)
88+
Defined in: [packages/form-core/src/FormApi.ts:960](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L960)
8989
9090
A record of field information for each field in the form.
9191
@@ -94,7 +94,7 @@ A record of field information for each field in the form.
9494
### fieldMetaDerived
9595
9696
```ts
97-
fieldMetaDerived: Derived<Record<DeepKeys<TFormData>, AnyFieldMeta>>;
97+
fieldMetaDerived: Derived<Partial<Record<DeepKeys<TFormData>, AnyFieldMeta>>>;
9898
```
9999
100100
Defined in: [packages/form-core/src/FormApi.ts:927](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L927)
@@ -119,7 +119,7 @@ The options for the form.
119119
store: Derived<FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>>;
120120
```
121121
122-
Defined in: [packages/form-core/src/FormApi.ts:928](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L928)
122+
Defined in: [packages/form-core/src/FormApi.ts:942](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L942)
123123
124124
## Accessors
125125
@@ -131,7 +131,7 @@ Defined in: [packages/form-core/src/FormApi.ts:928](https://github.com/TanStack/
131131
get formId(): string
132132
```
133133
134-
Defined in: [packages/form-core/src/FormApi.ts:1337](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1337)
134+
Defined in: [packages/form-core/src/FormApi.ts:1351](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1351)
135135
136136
##### Returns
137137
@@ -147,7 +147,7 @@ Defined in: [packages/form-core/src/FormApi.ts:1337](https://github.com/TanStack
147147
get state(): FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>
148148
```
149149
150-
Defined in: [packages/form-core/src/FormApi.ts:948](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L948)
150+
Defined in: [packages/form-core/src/FormApi.ts:962](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L962)
151151
152152
##### Returns
153153
@@ -161,7 +161,7 @@ Defined in: [packages/form-core/src/FormApi.ts:948](https://github.com/TanStack/
161161
clearFieldValues<TField>(field, options?): void
162162
```
163163
164-
Defined in: [packages/form-core/src/FormApi.ts:2481](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2481)
164+
Defined in: [packages/form-core/src/FormApi.ts:2493](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2493)
165165
166166
Clear all values within an array field.
167167
@@ -197,7 +197,7 @@ FieldManipulator.clearFieldValues
197197
deleteField<TField>(field): void
198198
```
199199
200-
Defined in: [packages/form-core/src/FormApi.ts:2273](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2273)
200+
Defined in: [packages/form-core/src/FormApi.ts:2285](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2285)
201201
202202
#### Type Parameters
203203
@@ -227,7 +227,7 @@ FieldManipulator.deleteField
227227
getAllErrors(): object
228228
```
229229
230-
Defined in: [packages/form-core/src/FormApi.ts:2596](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2596)
230+
Defined in: [packages/form-core/src/FormApi.ts:2608](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2608)
231231
232232
Returns form and field level errors
233233
@@ -280,7 +280,7 @@ errors: (
280280
getFieldInfo<TField>(field): FieldInfo<TFormData>
281281
```
282282
283-
Defined in: [packages/form-core/src/FormApi.ts:2176](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2176)
283+
Defined in: [packages/form-core/src/FormApi.ts:2188](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2188)
284284
285285
Gets the field info of the specified field.
286286
@@ -306,7 +306,7 @@ Gets the field info of the specified field.
306306
getFieldMeta<TField>(field): undefined | AnyFieldMeta
307307
```
308308
309-
Defined in: [packages/form-core/src/FormApi.ts:2167](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2167)
309+
Defined in: [packages/form-core/src/FormApi.ts:2179](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2179)
310310
311311
Gets the metadata of the specified field.
312312
@@ -338,7 +338,7 @@ FieldManipulator.getFieldMeta
338338
getFieldValue<TField>(field): DeepValue<TFormData, TField>
339339
```
340340
341-
Defined in: [packages/form-core/src/FormApi.ts:2160](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2160)
341+
Defined in: [packages/form-core/src/FormApi.ts:2172](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2172)
342342
343343
Gets the value of the specified field.
344344
@@ -372,7 +372,7 @@ FieldManipulator.getFieldValue
372372
handleSubmit(): Promise<void>
373373
```
374374
375-
Defined in: [packages/form-core/src/FormApi.ts:2012](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2012)
375+
Defined in: [packages/form-core/src/FormApi.ts:2024](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2024)
376376
377377
Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks.
378378
@@ -392,7 +392,7 @@ FieldManipulator.handleSubmit
392392
handleSubmit(submitMeta): Promise<void>
393393
```
394394
395-
Defined in: [packages/form-core/src/FormApi.ts:2013](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2013)
395+
Defined in: [packages/form-core/src/FormApi.ts:2025](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2025)
396396
397397
Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks.
398398
@@ -424,7 +424,7 @@ insertFieldValue<TField>(
424424
options?): Promise<void>
425425
```
426426
427-
Defined in: [packages/form-core/src/FormApi.ts:2311](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2311)
427+
Defined in: [packages/form-core/src/FormApi.ts:2323](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2323)
428428
429429
#### Type Parameters
430430
@@ -466,7 +466,7 @@ FieldManipulator.insertFieldValue
466466
mount(): () => void
467467
```
468468
469-
Defined in: [packages/form-core/src/FormApi.ts:1366](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1366)
469+
Defined in: [packages/form-core/src/FormApi.ts:1380](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1380)
470470
471471
#### Returns
472472
@@ -488,7 +488,7 @@ moveFieldValues<TField>(
488488
options?): void
489489
```
490490
491-
Defined in: [packages/form-core/src/FormApi.ts:2449](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2449)
491+
Defined in: [packages/form-core/src/FormApi.ts:2461](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2461)
492492
493493
Moves the value at the first specified index to the second specified index within an array field.
494494
@@ -537,7 +537,7 @@ parseValuesWithSchema(schema):
537537
}
538538
```
539539

540-
Defined in: [packages/form-core/src/FormApi.ts:2660](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2660)
540+
Defined in: [packages/form-core/src/FormApi.ts:2672](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2672)
541541

542542
Parses the form's values with a given standard schema and returns
543543
issues (if any). This method does NOT set any internal errors.
@@ -571,7 +571,7 @@ parseValuesWithSchemaAsync(schema): Promise<
571571
}>
572572
```
573573

574-
Defined in: [packages/form-core/src/FormApi.ts:2672](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2672)
574+
Defined in: [packages/form-core/src/FormApi.ts:2684](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2684)
575575

576576
Parses the form's values with a given standard schema and returns
577577
issues (if any). This method does NOT set any internal errors.
@@ -604,7 +604,7 @@ pushFieldValue<TField>(
604604
options?): void
605605
```
606606

607-
Defined in: [packages/form-core/src/FormApi.ts:2297](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2297)
607+
Defined in: [packages/form-core/src/FormApi.ts:2309](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2309)
608608

609609
Pushes a value into an array field.
610610

@@ -647,7 +647,7 @@ removeFieldValue<TField>(
647647
options?): Promise<void>
648648
```
649649

650-
Defined in: [packages/form-core/src/FormApi.ts:2377](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2377)
650+
Defined in: [packages/form-core/src/FormApi.ts:2389](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2389)
651651

652652
Removes a value from an array field at the specified index.
653653

@@ -691,7 +691,7 @@ replaceFieldValue<TField>(
691691
options?): Promise<void>
692692
```
693693

694-
Defined in: [packages/form-core/src/FormApi.ts:2348](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2348)
694+
Defined in: [packages/form-core/src/FormApi.ts:2360](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2360)
695695

696696
Replaces a value into an array field at the specified index.
697697

@@ -735,7 +735,7 @@ FieldManipulator.replaceFieldValue
735735
reset(values?, opts?): void
736736
```
737737

738-
Defined in: [packages/form-core/src/FormApi.ts:1477](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1477)
738+
Defined in: [packages/form-core/src/FormApi.ts:1491](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1491)
739739

740740
Resets the form state to the default values.
741741
If values are provided, the form will be reset to those values instead and the default values will be updated.
@@ -768,7 +768,7 @@ Optional options to control the reset behavior.
768768
resetField<TField>(field): void
769769
```
770770

771-
Defined in: [packages/form-core/src/FormApi.ts:2514](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2514)
771+
Defined in: [packages/form-core/src/FormApi.ts:2526](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2526)
772772

773773
Resets the field value and meta to default state
774774

@@ -797,10 +797,10 @@ FieldManipulator.resetField
797797
### resetFieldMeta()
798798

799799
```ts
800-
resetFieldMeta<TField>(fieldMeta): Record<TField, AnyFieldMeta>
800+
resetFieldMeta<TField>(fieldMeta): Partial<Record<TField, AnyFieldMeta>>
801801
```
802802

803-
Defined in: [packages/form-core/src/FormApi.ts:2217](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2217)
803+
Defined in: [packages/form-core/src/FormApi.ts:2229](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2229)
804804

805805
resets every field's meta
806806

@@ -812,11 +812,11 @@ resets every field's meta
812812

813813
##### fieldMeta
814814

815-
`Record`\<`TField`, [`AnyFieldMeta`](../../type-aliases/anyfieldmeta.md)\>
815+
`Partial`\<`Record`\<`TField`, [`AnyFieldMeta`](../../type-aliases/anyfieldmeta.md)\>\>
816816

817817
#### Returns
818818

819-
`Record`\<`TField`, [`AnyFieldMeta`](../../type-aliases/anyfieldmeta.md)\>
819+
`Partial`\<`Record`\<`TField`, [`AnyFieldMeta`](../../type-aliases/anyfieldmeta.md)\>\>
820820

821821
***
822822

@@ -826,7 +826,7 @@ resets every field's meta
826826
setErrorMap(errorMap): void
827827
```
828828

829-
Defined in: [packages/form-core/src/FormApi.ts:2532](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2532)
829+
Defined in: [packages/form-core/src/FormApi.ts:2544](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2544)
830830

831831
Updates the form's errorMap
832832

@@ -848,7 +848,7 @@ Updates the form's errorMap
848848
setFieldMeta<TField>(field, updater): void
849849
```
850850

851-
Defined in: [packages/form-core/src/FormApi.ts:2196](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2196)
851+
Defined in: [packages/form-core/src/FormApi.ts:2208](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2208)
852852

853853
Updates the metadata of the specified field.
854854

@@ -887,7 +887,7 @@ setFieldValue<TField>(
887887
opts?): void
888888
```
889889

890-
Defined in: [packages/form-core/src/FormApi.ts:2233](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2233)
890+
Defined in: [packages/form-core/src/FormApi.ts:2245](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2245)
891891

892892
Sets the value of the specified field and optionally updates the touched state.
893893

@@ -931,7 +931,7 @@ swapFieldValues<TField>(
931931
options?): void
932932
```
933933

934-
Defined in: [packages/form-core/src/FormApi.ts:2417](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2417)
934+
Defined in: [packages/form-core/src/FormApi.ts:2429](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2429)
935935

936936
Swaps the values at the specified indices within an array field.
937937

@@ -975,7 +975,7 @@ FieldManipulator.swapFieldValues
975975
update(options?): void
976976
```
977977

978-
Defined in: [packages/form-core/src/FormApi.ts:1401](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1401)
978+
Defined in: [packages/form-core/src/FormApi.ts:1415](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1415)
979979

980980
Updates the form options and form state.
981981

@@ -997,7 +997,7 @@ Updates the form options and form state.
997997
validateAllFields(cause): Promise<unknown[]>
998998
```
999999

1000-
Defined in: [packages/form-core/src/FormApi.ts:1503](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1503)
1000+
Defined in: [packages/form-core/src/FormApi.ts:1517](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1517)
10011001

10021002
Validates all fields using the correct handlers for a given validation cause.
10031003

@@ -1028,7 +1028,7 @@ validateArrayFieldsStartingFrom<TField>(
10281028
cause): Promise<unknown[]>
10291029
```
10301030

1031-
Defined in: [packages/form-core/src/FormApi.ts:1533](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1533)
1031+
Defined in: [packages/form-core/src/FormApi.ts:1547](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1547)
10321032

10331033
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.
10341034

@@ -1068,7 +1068,7 @@ FieldManipulator.validateArrayFieldsStartingFrom
10681068
validateField<TField>(field, cause): unknown[] | Promise<unknown[]>
10691069
```
10701070

1071-
Defined in: [packages/form-core/src/FormApi.ts:1574](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1574)
1071+
Defined in: [packages/form-core/src/FormApi.ts:1588](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1588)
10721072

10731073
Validates a specified field in the form using the correct handlers for a given validation type.
10741074

docs/reference/interfaces/formstate.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ DerivedFormState.errors
126126
### fieldMeta
127127

128128
```ts
129-
fieldMeta: Record<DeepKeys<TFormData>, AnyFieldMeta>;
129+
fieldMeta: Partial<Record<DeepKeys<TFormData>, AnyFieldMeta>>;
130130
```
131131

132132
Defined in: [packages/form-core/src/FormApi.ts:736](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L736)
@@ -144,7 +144,7 @@ DerivedFormState.fieldMeta
144144
### fieldMetaBase
145145

146146
```ts
147-
fieldMetaBase: Record<DeepKeys<TFormData>, AnyFieldMetaBase>;
147+
fieldMetaBase: Partial<Record<DeepKeys<TFormData>, AnyFieldMetaBase>>;
148148
```
149149

150150
Defined in: [packages/form-core/src/FormApi.ts:621](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L621)

docs/reference/type-aliases/baseformstate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ The error map for the form itself.
6060
### fieldMetaBase
6161

6262
```ts
63-
fieldMetaBase: Record<DeepKeys<TFormData>, AnyFieldMetaBase>;
63+
fieldMetaBase: Partial<Record<DeepKeys<TFormData>, AnyFieldMetaBase>>;
6464
```
6565

6666
A record of field metadata for each field in the form, not including the derived properties, like `errors` and such

docs/reference/type-aliases/derivedformstate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The error array for the form itself.
6868
### fieldMeta
6969

7070
```ts
71-
fieldMeta: Record<DeepKeys<TFormData>, AnyFieldMeta>;
71+
fieldMeta: Partial<Record<DeepKeys<TFormData>, AnyFieldMeta>>;
7272
```
7373

7474
A record of field metadata for each field in the form.

0 commit comments

Comments
 (0)