Skip to content

Commit 139452c

Browse files
ci: apply automated fixes and generate docs
1 parent e82f0a8 commit 139452c

File tree

2 files changed

+86
-66
lines changed

2 files changed

+86
-66
lines changed

docs/reference/classes/FieldApi.md

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

66
# Class: FieldApi\<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta\>
77

8-
Defined in: [packages/form-core/src/FieldApi.ts:974](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L974)
8+
Defined in: [packages/form-core/src/FieldApi.ts:979](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L979)
99

1010
A class representing the API for managing a form field.
1111

@@ -117,7 +117,7 @@ the `new FieldApi` constructor.
117117
new FieldApi<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>;
118118
```
119119

120-
Defined in: [packages/form-core/src/FieldApi.ts:1128](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1128)
120+
Defined in: [packages/form-core/src/FieldApi.ts:1133](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1133)
121121

122122
Initializes a new `FieldApi` instance.
123123

@@ -139,7 +139,7 @@ Initializes a new `FieldApi` instance.
139139
form: FormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>;
140140
```
141141

142-
Defined in: [packages/form-core/src/FieldApi.ts:1028](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1028)
142+
Defined in: [packages/form-core/src/FieldApi.ts:1033](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1033)
143143

144144
A reference to the form API instance.
145145

@@ -151,7 +151,7 @@ A reference to the form API instance.
151151
name: TName;
152152
```
153153

154-
Defined in: [packages/form-core/src/FieldApi.ts:1056](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1056)
154+
Defined in: [packages/form-core/src/FieldApi.ts:1061](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1061)
155155

156156
The field name.
157157

@@ -163,7 +163,7 @@ The field name.
163163
options: FieldApiOptions<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>;
164164
```
165165

166-
Defined in: [packages/form-core/src/FieldApi.ts:1060](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1060)
166+
Defined in: [packages/form-core/src/FieldApi.ts:1065](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1065)
167167

168168
The field options.
169169

@@ -175,7 +175,7 @@ The field options.
175175
store: Derived<FieldState<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync>>;
176176
```
177177

178-
Defined in: [packages/form-core/src/FieldApi.ts:1088](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1088)
178+
Defined in: [packages/form-core/src/FieldApi.ts:1093](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1093)
179179

180180
The field state store.
181181

@@ -187,7 +187,7 @@ The field state store.
187187
timeoutIds: object;
188188
```
189189

190-
Defined in: [packages/form-core/src/FieldApi.ts:1119](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1119)
190+
Defined in: [packages/form-core/src/FieldApi.ts:1124](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1124)
191191

192192
#### formListeners
193193

@@ -217,7 +217,7 @@ validations: Record<ValidationCause, ReturnType<typeof setTimeout> | null>;
217217
get state(): FieldState<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync>;
218218
```
219219

220-
Defined in: [packages/form-core/src/FieldApi.ts:1116](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1116)
220+
Defined in: [packages/form-core/src/FieldApi.ts:1121](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1121)
221221

222222
The current field state.
223223

@@ -233,7 +233,7 @@ The current field state.
233233
clearValues(options?): void;
234234
```
235235
236-
Defined in: [packages/form-core/src/FieldApi.ts:1519](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1519)
236+
Defined in: [packages/form-core/src/FieldApi.ts:1524](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1524)
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:1405](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1405)
258+
Defined in: [packages/form-core/src/FieldApi.ts:1410](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1410)
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:1369](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1369)
274+
Defined in: [packages/form-core/src/FieldApi.ts:1374](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1374)
275275
276276
#### Returns
277277
@@ -285,7 +285,7 @@ Defined in: [packages/form-core/src/FieldApi.ts:1369](https://github.com/TanStac
285285
getValue(): TData;
286286
```
287287
288-
Defined in: [packages/form-core/src/FieldApi.ts:1346](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1346)
288+
Defined in: [packages/form-core/src/FieldApi.ts:1351](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1351)
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:1895](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1895)
308+
Defined in: [packages/form-core/src/FieldApi.ts:1900](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1900)
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:1888](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1888)
324+
Defined in: [packages/form-core/src/FieldApi.ts:1893](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1893)
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:1428](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1428)
349+
Defined in: [packages/form-core/src/FieldApi.ts:1433](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1433)
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:1242](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1242)
379+
Defined in: [packages/form-core/src/FieldApi.ts:1247](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1247)
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:1503](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1503)
404+
Defined in: [packages/form-core/src/FieldApi.ts:1508](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1508)
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:1938](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1938)
436+
Defined in: [packages/form-core/src/FieldApi.ts:1943](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1943)
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:1950](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1950)
464+
Defined in: [packages/form-core/src/FieldApi.ts:1955](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1955)
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:1410](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1410)
491+
Defined in: [packages/form-core/src/FieldApi.ts:1415](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1415)
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:1468](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1468)
517+
Defined in: [packages/form-core/src/FieldApi.ts:1473](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1473)
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:1448](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1448)
546+
Defined in: [packages/form-core/src/FieldApi.ts:1453](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1453)
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:1911](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1911)
576+
Defined in: [packages/form-core/src/FieldApi.ts:1916](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1916)
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:1374](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1374)
598+
Defined in: [packages/form-core/src/FieldApi.ts:1379](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1379)
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:1353](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1353)
620+
Defined in: [packages/form-core/src/FieldApi.ts:1358](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1358)
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:1483](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1483)
649+
Defined in: [packages/form-core/src/FieldApi.ts:1488](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1488)
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:1295](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1295)
679+
Defined in: [packages/form-core/src/FieldApi.ts:1300](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1300)
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:1855](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1855)
701+
Defined in: [packages/form-core/src/FieldApi.ts:1860](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1860)
702702
703703
Validates the field value.
704704

0 commit comments

Comments
 (0)