Skip to content

Commit 7a4b530

Browse files
ci: apply automated fixes and generate docs
1 parent 83bb01c commit 7a4b530

File tree

6 files changed

+25
-25
lines changed

6 files changed

+25
-25
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: Field
99
function Field<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>(props): Element;
1010
```
1111

12-
Defined in: [packages/solid-form/src/createField.tsx:717](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L717)
12+
Defined in: [packages/solid-form/src/createField.tsx:724](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L724)
1313

1414
## Type Parameters
1515

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: createField
99
function createField<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>(opts): () => FieldApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta> & SolidFieldApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>;
1010
```
1111

12-
Defined in: [packages/solid-form/src/createField.tsx:259](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L259)
12+
Defined in: [packages/solid-form/src/createField.tsx:266](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L266)
1313

1414
## Type Parameters
1515

docs/framework/solid/reference/type-aliases/CreateField.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: CreateField
99
type CreateField<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta> = <TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>(opts) => () => FieldApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta> & SolidFieldApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>;
1010
```
1111

12-
Defined in: [packages/solid-form/src/createField.tsx:53](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L53)
12+
Defined in: [packages/solid-form/src/createField.tsx:54](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L54)
1313

1414
## Type Parameters
1515

docs/framework/solid/reference/type-aliases/FieldComponent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ type FieldComponent<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync
1212
}) => JSX.Element;
1313
```
1414

15-
Defined in: [packages/solid-form/src/createField.tsx:471](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L471)
15+
Defined in: [packages/solid-form/src/createField.tsx:478](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L478)
1616

1717
A type alias representing a field component for a specific form data type.
1818

docs/framework/solid/reference/type-aliases/LensFieldComponent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ type LensFieldComponent<TLensData, TParentSubmitMeta, ExtendedApi> = <TName, TDa
1212
}) => JSX.Element;
1313
```
1414

15-
Defined in: [packages/solid-form/src/createField.tsx:632](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L632)
15+
Defined in: [packages/solid-form/src/createField.tsx:639](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L639)
1616

1717
A type alias representing a field component for a form lens data type.
1818

docs/reference/classes/FieldApi.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ The current field state.
233233
clearValues(options?): void;
234234
```
235235
236-
Defined in: [packages/form-core/src/FieldApi.ts:1525](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1525)
236+
Defined in: [packages/form-core/src/FieldApi.ts:1555](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1555)
237237
238238
Clear all values from the array.
239239
@@ -255,7 +255,7 @@ Clear all values from the array.
255255
getInfo(): FieldInfo<TParentData>;
256256
```
257257
258-
Defined in: [packages/form-core/src/FieldApi.ts:1411](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1411)
258+
Defined in: [packages/form-core/src/FieldApi.ts:1441](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1441)
259259
260260
Gets the field information object.
261261
@@ -271,7 +271,7 @@ Gets the field information object.
271271
getMeta(): FieldMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync>;
272272
```
273273
274-
Defined in: [packages/form-core/src/FieldApi.ts:1375](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1375)
274+
Defined in: [packages/form-core/src/FieldApi.ts:1405](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1405)
275275
276276
#### Returns
277277
@@ -285,7 +285,7 @@ Defined in: [packages/form-core/src/FieldApi.ts:1375](https://github.com/TanStac
285285
getValue(): TData;
286286
```
287287
288-
Defined in: [packages/form-core/src/FieldApi.ts:1352](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1352)
288+
Defined in: [packages/form-core/src/FieldApi.ts:1382](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1382)
289289
290290
Gets the current field value.
291291
@@ -305,7 +305,7 @@ Use `field.state.value` instead.
305305
handleBlur(): void;
306306
```
307307
308-
Defined in: [packages/form-core/src/FieldApi.ts:1913](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1913)
308+
Defined in: [packages/form-core/src/FieldApi.ts:1943](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1943)
309309
310310
Handles the blur event.
311311
@@ -321,7 +321,7 @@ Handles the blur event.
321321
handleChange(updater): void;
322322
```
323323
324-
Defined in: [packages/form-core/src/FieldApi.ts:1906](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1906)
324+
Defined in: [packages/form-core/src/FieldApi.ts:1936](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1936)
325325
326326
Handles the change event.
327327
@@ -346,7 +346,7 @@ insertValue(
346346
options?): void;
347347
```
348348
349-
Defined in: [packages/form-core/src/FieldApi.ts:1434](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1434)
349+
Defined in: [packages/form-core/src/FieldApi.ts:1464](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1464)
350350
351351
Inserts a value at the specified index, shifting the subsequent values to the right.
352352
@@ -376,7 +376,7 @@ Inserts a value at the specified index, shifting the subsequent values to the ri
376376
mount(): () => void;
377377
```
378378
379-
Defined in: [packages/form-core/src/FieldApi.ts:1247](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1247)
379+
Defined in: [packages/form-core/src/FieldApi.ts:1277](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1277)
380380
381381
Mounts the field instance to the form.
382382
@@ -401,7 +401,7 @@ moveValue(
401401
options?): void;
402402
```
403403
404-
Defined in: [packages/form-core/src/FieldApi.ts:1509](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1509)
404+
Defined in: [packages/form-core/src/FieldApi.ts:1539](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1539)
405405
406406
Moves the value at the first specified index to the second specified index.
407407
@@ -433,7 +433,7 @@ parseValueWithSchema(schema):
433433
| undefined;
434434
```
435435
436-
Defined in: [packages/form-core/src/FieldApi.ts:1956](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1956)
436+
Defined in: [packages/form-core/src/FieldApi.ts:1986](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1986)
437437
438438
Parses the field's value with the given schema and returns
439439
issues (if any). This method does NOT set any internal errors.
@@ -461,7 +461,7 @@ parseValueWithSchemaAsync(schema): Promise<
461461
| undefined>;
462462
```
463463
464-
Defined in: [packages/form-core/src/FieldApi.ts:1968](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1968)
464+
Defined in: [packages/form-core/src/FieldApi.ts:1998](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1998)
465465
466466
Parses the field's value with the given schema and returns
467467
issues (if any). This method does NOT set any internal errors.
@@ -488,7 +488,7 @@ The standard schema to parse this field's value with.
488488
pushValue(value, options?): void;
489489
```
490490
491-
Defined in: [packages/form-core/src/FieldApi.ts:1416](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1416)
491+
Defined in: [packages/form-core/src/FieldApi.ts:1446](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1446)
492492
493493
Pushes a new value to the field.
494494
@@ -514,7 +514,7 @@ Pushes a new value to the field.
514514
removeValue(index, options?): void;
515515
```
516516
517-
Defined in: [packages/form-core/src/FieldApi.ts:1474](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1474)
517+
Defined in: [packages/form-core/src/FieldApi.ts:1504](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1504)
518518
519519
Removes a value at the specified index.
520520
@@ -543,7 +543,7 @@ replaceValue(
543543
options?): void;
544544
```
545545
546-
Defined in: [packages/form-core/src/FieldApi.ts:1454](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1454)
546+
Defined in: [packages/form-core/src/FieldApi.ts:1484](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1484)
547547
548548
Replaces a value at the specified index.
549549
@@ -573,7 +573,7 @@ Replaces a value at the specified index.
573573
setErrorMap(errorMap): void;
574574
```
575575
576-
Defined in: [packages/form-core/src/FieldApi.ts:1929](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1929)
576+
Defined in: [packages/form-core/src/FieldApi.ts:1959](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1959)
577577
578578
Updates the field's errorMap
579579
@@ -595,7 +595,7 @@ Updates the field's errorMap
595595
setMeta(updater): void;
596596
```
597597
598-
Defined in: [packages/form-core/src/FieldApi.ts:1380](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1380)
598+
Defined in: [packages/form-core/src/FieldApi.ts:1410](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1410)
599599
600600
Sets the field metadata.
601601
@@ -617,7 +617,7 @@ Sets the field metadata.
617617
setValue(updater, options?): void;
618618
```
619619
620-
Defined in: [packages/form-core/src/FieldApi.ts:1359](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1359)
620+
Defined in: [packages/form-core/src/FieldApi.ts:1389](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1389)
621621
622622
Sets the field value and run the `change` validator.
623623
@@ -646,7 +646,7 @@ swapValues(
646646
options?): void;
647647
```
648648
649-
Defined in: [packages/form-core/src/FieldApi.ts:1489](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1489)
649+
Defined in: [packages/form-core/src/FieldApi.ts:1519](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1519)
650650
651651
Swaps the values at the specified indices.
652652
@@ -676,7 +676,7 @@ Swaps the values at the specified indices.
676676
update(opts): void;
677677
```
678678
679-
Defined in: [packages/form-core/src/FieldApi.ts:1301](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1301)
679+
Defined in: [packages/form-core/src/FieldApi.ts:1331](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1331)
680680
681681
Updates the field instance with new options.
682682
@@ -698,7 +698,7 @@ Updates the field instance with new options.
698698
validate(cause, opts?): unknown[] | Promise<unknown[]>;
699699
```
700700
701-
Defined in: [packages/form-core/src/FieldApi.ts:1873](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1873)
701+
Defined in: [packages/form-core/src/FieldApi.ts:1903](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1903)
702702
703703
Validates the field value.
704704

0 commit comments

Comments
 (0)