Skip to content

Commit

Permalink
ci: apply automated fixes and generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@autofix-ci
autofix-ci[bot] authored Oct 28, 2024
1 parent fade2f0 commit a2f3923
Showing 1 changed file with 37 additions and 37 deletions.
74 changes: 37 additions & 37 deletions docs/reference/classes/formapi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ deleteField<TField>(field): void
#### Defined in
[packages/form-core/src/FormApi.ts:1076](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1076)
[packages/form-core/src/FormApi.ts:1084](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1084)
***
Expand All @@ -147,7 +147,7 @@ Gets the field info of the specified field.
#### Defined in
[packages/form-core/src/FormApi.ts:992](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L992)
[packages/form-core/src/FormApi.ts:1000](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1000)
***
Expand All @@ -173,7 +173,7 @@ Gets the metadata of the specified field.
#### Defined in
[packages/form-core/src/FormApi.ts:983](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L983)
[packages/form-core/src/FormApi.ts:991](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L991)
***
Expand All @@ -199,7 +199,7 @@ Gets the value of the specified field.
#### Defined in
[packages/form-core/src/FormApi.ts:976](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L976)
[packages/form-core/src/FormApi.ts:984](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L984)
***
Expand All @@ -217,17 +217,17 @@ Handles the form submission, performs validation, and calls the appropriate onSu
#### Defined in
[packages/form-core/src/FormApi.ts:916](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L916)
[packages/form-core/src/FormApi.ts:911](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L911)
***
### insertFieldValue()
```ts
insertFieldValue<TField>(
field,
index,
value,
field,
index,
value,
opts?): Promise<void>
```
Expand All @@ -253,7 +253,7 @@ Inserts a value into an array field at the specified index, shifting the subsequ
#### Defined in
[packages/form-core/src/FormApi.ts:1108](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1108)
[packages/form-core/src/FormApi.ts:1116](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1116)
***
Expand All @@ -277,9 +277,9 @@ mount(): void
```ts
moveFieldValues<TField>(
field,
index1,
index2,
field,
index1,
index2,
opts?): void
```
Expand All @@ -305,16 +305,16 @@ Moves the value at the first specified index to the second specified index withi
#### Defined in
[packages/form-core/src/FormApi.ts:1226](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1226)
[packages/form-core/src/FormApi.ts:1234](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1234)
***
### pushFieldValue()
```ts
pushFieldValue<TField>(
field,
value,
field,
value,
opts?): void
```
Expand All @@ -338,16 +338,16 @@ Pushes a value into an array field.
#### Defined in
[packages/form-core/src/FormApi.ts:1090](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1090)
[packages/form-core/src/FormApi.ts:1098](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1098)
***
### removeFieldValue()
```ts
removeFieldValue<TField>(
field,
index,
field,
index,
opts?): Promise<void>
```
Expand All @@ -371,17 +371,17 @@ Removes a value from an array field at the specified index.
#### Defined in
[packages/form-core/src/FormApi.ts:1161](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1161)
[packages/form-core/src/FormApi.ts:1169](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1169)
***
### replaceFieldValue()
```ts
replaceFieldValue<TField>(
field,
index,
value,
field,
index,
value,
opts?): Promise<void>
```
Expand All @@ -407,7 +407,7 @@ Replaces a value into an array field at the specified index.
#### Defined in
[packages/form-core/src/FormApi.ts:1135](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1135)
[packages/form-core/src/FormApi.ts:1143](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1143)
***
Expand Down Expand Up @@ -449,7 +449,7 @@ resetFieldMeta<TField>(fieldMeta): Record<TField, FieldMeta>
#### Defined in
[packages/form-core/src/FormApi.ts:1026](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1026)
[packages/form-core/src/FormApi.ts:1034](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1034)
***
Expand All @@ -471,7 +471,7 @@ Updates the form's errorMap
#### Defined in
[packages/form-core/src/FormApi.ts:1250](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1250)
[packages/form-core/src/FormApi.ts:1258](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1258)
***
Expand Down Expand Up @@ -499,16 +499,16 @@ Updates the metadata of the specified field.
#### Defined in
[packages/form-core/src/FormApi.ts:1011](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1011)
[packages/form-core/src/FormApi.ts:1019](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1019)
***
### setFieldValue()
```ts
setFieldValue<TField>(
field,
updater,
field,
updater,
opts?): void
```
Expand All @@ -532,17 +532,17 @@ Sets the value of the specified field and optionally updates the touched state.
#### Defined in
[packages/form-core/src/FormApi.ts:1050](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1050)
[packages/form-core/src/FormApi.ts:1058](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1058)
***
### swapFieldValues()
```ts
swapFieldValues<TField>(
field,
index1,
index2,
field,
index1,
index2,
opts?): void
```
Expand All @@ -568,7 +568,7 @@ Swaps the values at the specified indices within an array field.
#### Defined in
[packages/form-core/src/FormApi.ts:1200](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1200)
[packages/form-core/src/FormApi.ts:1208](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1208)
***
Expand Down Expand Up @@ -620,8 +620,8 @@ Validates all fields in the form using the correct handlers for a given validati
```ts
validateArrayFieldsStartingFrom<TField>(
field,
index,
field,
index,
cause): Promise<ValidationError[]>
```
Expand All @@ -645,7 +645,7 @@ Validates the children of a specified array in the form starting from a given in
#### Defined in
[packages/form-core/src/FormApi.ts:611](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L611)
[packages/form-core/src/FormApi.ts:605](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L605)
***
Expand Down Expand Up @@ -673,4 +673,4 @@ Validates a specified field in the form using the correct handlers for a given v
#### Defined in
[packages/form-core/src/FormApi.ts:650](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L650)
[packages/form-core/src/FormApi.ts:644](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L644)

0 comments on commit a2f3923

Please sign in to comment.