Skip to content

Commit 2ee0e89

Browse files
ci: apply automated fixes and generate docs
1 parent 443d270 commit 2ee0e89

File tree

10 files changed

+74
-66
lines changed

10 files changed

+74
-66
lines changed

docs/reference/classes/fieldapi.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: FieldApi
77

88
# Class: FieldApi\<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TParentSubmitMeta\>
99

10-
Defined in: [packages/form-core/src/FieldApi.ts:855](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L855)
10+
Defined in: [packages/form-core/src/FieldApi.ts:859](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L859)
1111

1212
A class representing the API for managing a form field.
1313

@@ -65,7 +65,7 @@ the `new FieldApi` constructor.
6565
new FieldApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TParentSubmitMeta>(opts): FieldApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TParentSubmitMeta>
6666
```
6767

68-
Defined in: [packages/form-core/src/FieldApi.ts:987](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L987)
68+
Defined in: [packages/form-core/src/FieldApi.ts:991](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L991)
6969

7070
Initializes a new `FieldApi` instance.
7171

@@ -87,7 +87,7 @@ Initializes a new `FieldApi` instance.
8787
form: FormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TParentSubmitMeta>;
8888
```
8989

90-
Defined in: [packages/form-core/src/FieldApi.ts:899](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L899)
90+
Defined in: [packages/form-core/src/FieldApi.ts:903](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L903)
9191

9292
A reference to the form API instance.
9393

@@ -99,7 +99,7 @@ A reference to the form API instance.
9999
name: DeepKeys<TParentData>;
100100
```
101101

102-
Defined in: [packages/form-core/src/FieldApi.ts:923](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L923)
102+
Defined in: [packages/form-core/src/FieldApi.ts:927](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L927)
103103

104104
The field name.
105105

@@ -111,7 +111,7 @@ The field name.
111111
options: FieldApiOptions<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TParentSubmitMeta>;
112112
```
113113

114-
Defined in: [packages/form-core/src/FieldApi.ts:927](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L927)
114+
Defined in: [packages/form-core/src/FieldApi.ts:931](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L931)
115115

116116
The field options.
117117

@@ -123,7 +123,7 @@ The field options.
123123
store: Derived<FieldState<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync>>;
124124
```
125125

126-
Defined in: [packages/form-core/src/FieldApi.ts:951](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L951)
126+
Defined in: [packages/form-core/src/FieldApi.ts:955](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L955)
127127

128128
The field state store.
129129

@@ -135,7 +135,7 @@ The field state store.
135135
timeoutIds: object;
136136
```
137137

138-
Defined in: [packages/form-core/src/FieldApi.ts:978](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L978)
138+
Defined in: [packages/form-core/src/FieldApi.ts:982](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L982)
139139

140140
#### formListeners
141141

@@ -165,7 +165,7 @@ validations: Record<ValidationCause, null | Timeout>;
165165
get state(): FieldState<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync>
166166
```
167167

168-
Defined in: [packages/form-core/src/FieldApi.ts:975](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L975)
168+
Defined in: [packages/form-core/src/FieldApi.ts:979](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L979)
169169

170170
The current field state.
171171

@@ -181,7 +181,7 @@ The current field state.
181181
getInfo(): FieldInfo<TParentData>
182182
```
183183

184-
Defined in: [packages/form-core/src/FieldApi.ts:1241](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1241)
184+
Defined in: [packages/form-core/src/FieldApi.ts:1245](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1245)
185185

186186
Gets the field information object.
187187

@@ -197,7 +197,7 @@ Gets the field information object.
197197
getMeta(): FieldMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync>
198198
```
199199

200-
Defined in: [packages/form-core/src/FieldApi.ts:1209](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1209)
200+
Defined in: [packages/form-core/src/FieldApi.ts:1213](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1213)
201201

202202
#### Returns
203203

@@ -211,7 +211,7 @@ Defined in: [packages/form-core/src/FieldApi.ts:1209](https://github.com/TanStac
211211
getValue(): TData
212212
```
213213

214-
Defined in: [packages/form-core/src/FieldApi.ts:1194](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1194)
214+
Defined in: [packages/form-core/src/FieldApi.ts:1198](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1198)
215215

216216
Gets the current field value.
217217

@@ -231,7 +231,7 @@ Use `field.state.value` instead.
231231
handleBlur(): void
232232
```
233233

234-
Defined in: [packages/form-core/src/FieldApi.ts:1653](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1653)
234+
Defined in: [packages/form-core/src/FieldApi.ts:1657](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1657)
235235

236236
Handles the blur event.
237237

@@ -247,7 +247,7 @@ Handles the blur event.
247247
handleChange(updater): void
248248
```
249249

250-
Defined in: [packages/form-core/src/FieldApi.ts:1646](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1646)
250+
Defined in: [packages/form-core/src/FieldApi.ts:1650](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1650)
251251

252252
Handles the change event.
253253

@@ -272,7 +272,7 @@ insertValue(
272272
opts?): void
273273
```
274274
275-
Defined in: [packages/form-core/src/FieldApi.ts:1258](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1258)
275+
Defined in: [packages/form-core/src/FieldApi.ts:1262](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1262)
276276
277277
Inserts a value at the specified index, shifting the subsequent values to the right.
278278
@@ -302,7 +302,7 @@ Inserts a value at the specified index, shifting the subsequent values to the ri
302302
mount(): () => void
303303
```
304304
305-
Defined in: [packages/form-core/src/FieldApi.ts:1084](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1084)
305+
Defined in: [packages/form-core/src/FieldApi.ts:1088](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1088)
306306
307307
Mounts the field instance to the form.
308308
@@ -325,7 +325,7 @@ moveValue(
325325
opts?): void
326326
```
327327
328-
Defined in: [packages/form-core/src/FieldApi.ts:1302](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1302)
328+
Defined in: [packages/form-core/src/FieldApi.ts:1306](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1306)
329329
330330
Moves the value at the first specified index to the second specified index.
331331
@@ -357,7 +357,7 @@ parseValueWithSchema(schema):
357357
| StandardSchemaV1Issue[]
358358
```
359359
360-
Defined in: [packages/form-core/src/FieldApi.ts:1688](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1688)
360+
Defined in: [packages/form-core/src/FieldApi.ts:1692](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1692)
361361
362362
Parses the field's value with the given schema and returns
363363
issues (if any). This method does NOT set any internal errors.
@@ -385,7 +385,7 @@ parseValueWithSchemaAsync(schema): Promise<
385385
| StandardSchemaV1Issue[]>
386386
```
387387
388-
Defined in: [packages/form-core/src/FieldApi.ts:1700](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1700)
388+
Defined in: [packages/form-core/src/FieldApi.ts:1704](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1704)
389389
390390
Parses the field's value with the given schema and returns
391391
issues (if any). This method does NOT set any internal errors.
@@ -412,7 +412,7 @@ The standard schema to parse this field's value with.
412412
pushValue(value, opts?): void
413413
```
414414
415-
Defined in: [packages/form-core/src/FieldApi.ts:1246](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1246)
415+
Defined in: [packages/form-core/src/FieldApi.ts:1250](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1250)
416416
417417
Pushes a new value to the field.
418418
@@ -438,7 +438,7 @@ Pushes a new value to the field.
438438
removeValue(index, opts?): void
439439
```
440440
441-
Defined in: [packages/form-core/src/FieldApi.ts:1284](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1284)
441+
Defined in: [packages/form-core/src/FieldApi.ts:1288](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1288)
442442
443443
Removes a value at the specified index.
444444
@@ -467,7 +467,7 @@ replaceValue(
467467
opts?): void
468468
```
469469
470-
Defined in: [packages/form-core/src/FieldApi.ts:1271](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1271)
470+
Defined in: [packages/form-core/src/FieldApi.ts:1275](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1275)
471471
472472
Replaces a value at the specified index.
473473
@@ -497,7 +497,7 @@ Replaces a value at the specified index.
497497
setErrorMap(errorMap): void
498498
```
499499
500-
Defined in: [packages/form-core/src/FieldApi.ts:1670](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1670)
500+
Defined in: [packages/form-core/src/FieldApi.ts:1674](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1674)
501501
502502
Updates the field's errorMap
503503
@@ -519,7 +519,7 @@ Updates the field's errorMap
519519
setMeta(updater): void
520520
```
521521
522-
Defined in: [packages/form-core/src/FieldApi.ts:1214](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1214)
522+
Defined in: [packages/form-core/src/FieldApi.ts:1218](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1218)
523523
524524
Sets the field metadata.
525525
@@ -541,7 +541,7 @@ Sets the field metadata.
541541
setValue(updater, options?): void
542542
```
543543
544-
Defined in: [packages/form-core/src/FieldApi.ts:1201](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1201)
544+
Defined in: [packages/form-core/src/FieldApi.ts:1205](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1205)
545545
546546
Sets the field value and run the `change` validator.
547547
@@ -570,7 +570,7 @@ swapValues(
570570
opts?): void
571571
```
572572
573-
Defined in: [packages/form-core/src/FieldApi.ts:1293](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1293)
573+
Defined in: [packages/form-core/src/FieldApi.ts:1297](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1297)
574574
575575
Swaps the values at the specified indices.
576576
@@ -600,7 +600,7 @@ Swaps the values at the specified indices.
600600
update(opts): void
601601
```
602602
603-
Defined in: [packages/form-core/src/FieldApi.ts:1137](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1137)
603+
Defined in: [packages/form-core/src/FieldApi.ts:1141](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1141)
604604
605605
Updates the field instance with new options.
606606
@@ -622,7 +622,7 @@ Updates the field instance with new options.
622622
validate(cause, opts?): unknown[] | Promise<unknown[]>
623623
```
624624
625-
Defined in: [packages/form-core/src/FieldApi.ts:1613](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1613)
625+
Defined in: [packages/form-core/src/FieldApi.ts:1617](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1617)
626626
627627
Validates the field value.
628628

0 commit comments

Comments
 (0)