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[bot] authored Dec 11, 2024
1 parent aeac868 commit df0fb00
Show file tree
Hide file tree
Showing 9 changed files with 62 additions and 62 deletions.
48 changes: 24 additions & 24 deletions docs/reference/classes/fieldapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Initializes a new `FieldApi` instance.

#### Defined in

[packages/form-core/src/FieldApi.ts:513](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L513)
[packages/form-core/src/FieldApi.ts:518](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L518)

## Properties

Expand All @@ -61,7 +61,7 @@ A reference to the form API instance.

#### Defined in

[packages/form-core/src/FieldApi.ts:475](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L475)
[packages/form-core/src/FieldApi.ts:480](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L480)

***

Expand All @@ -75,7 +75,7 @@ The field name.

#### Defined in

[packages/form-core/src/FieldApi.ts:485](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L485)
[packages/form-core/src/FieldApi.ts:490](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L490)

***

Expand All @@ -89,7 +89,7 @@ The field options.

#### Defined in

[packages/form-core/src/FieldApi.ts:489](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L489)
[packages/form-core/src/FieldApi.ts:494](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L494)

***

Expand All @@ -103,7 +103,7 @@ The current field state.

#### Defined in

[packages/form-core/src/FieldApi.ts:503](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L503)
[packages/form-core/src/FieldApi.ts:508](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L508)

***

Expand All @@ -117,7 +117,7 @@ The field state store.

#### Defined in

[packages/form-core/src/FieldApi.ts:499](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L499)
[packages/form-core/src/FieldApi.ts:504](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L504)

***

Expand All @@ -129,7 +129,7 @@ timeoutIds: Record<ValidationCause, null | Timeout>;

#### Defined in

[packages/form-core/src/FieldApi.ts:508](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L508)
[packages/form-core/src/FieldApi.ts:513](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L513)

## Methods

Expand All @@ -147,7 +147,7 @@ Gets the field information object.

#### Defined in

[packages/form-core/src/FieldApi.ts:752](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L752)
[packages/form-core/src/FieldApi.ts:757](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L757)

***

Expand All @@ -165,7 +165,7 @@ Gets the current field metadata.

#### Defined in

[packages/form-core/src/FieldApi.ts:730](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L730)
[packages/form-core/src/FieldApi.ts:735](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L735)

***

Expand All @@ -187,7 +187,7 @@ Use `field.state.value` instead.

#### Defined in

[packages/form-core/src/FieldApi.ts:704](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L704)
[packages/form-core/src/FieldApi.ts:709](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L709)

***

Expand All @@ -205,7 +205,7 @@ Handles the blur event.

#### Defined in

[packages/form-core/src/FieldApi.ts:1104](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1104)
[packages/form-core/src/FieldApi.ts:1109](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1109)

***

Expand All @@ -229,7 +229,7 @@ Handles the change event.

#### Defined in

[packages/form-core/src/FieldApi.ts:1097](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1097)
[packages/form-core/src/FieldApi.ts:1102](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1102)

***

Expand Down Expand Up @@ -264,7 +264,7 @@ Inserts a value at the specified index, shifting the subsequent values to the ri
#### Defined in
[packages/form-core/src/FieldApi.ts:765](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L765)
[packages/form-core/src/FieldApi.ts:770](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L770)
***
Expand All @@ -286,7 +286,7 @@ Mounts the field instance to the form.
#### Defined in
[packages/form-core/src/FieldApi.ts:614](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L614)
[packages/form-core/src/FieldApi.ts:619](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L619)
***
Expand Down Expand Up @@ -321,7 +321,7 @@ Moves the value at the first specified index to the second specified index.
#### Defined in
[packages/form-core/src/FieldApi.ts:795](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L795)
[packages/form-core/src/FieldApi.ts:800](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L800)
***
Expand Down Expand Up @@ -349,7 +349,7 @@ Pushes a new value to the field.
#### Defined in
[packages/form-core/src/FieldApi.ts:757](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L757)
[packages/form-core/src/FieldApi.ts:762](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L762)
***
Expand Down Expand Up @@ -377,7 +377,7 @@ Removes a value at the specified index.
#### Defined in
[packages/form-core/src/FieldApi.ts:783](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L783)
[packages/form-core/src/FieldApi.ts:788](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L788)
***
Expand Down Expand Up @@ -412,7 +412,7 @@ Replaces a value at the specified index.
#### Defined in
[packages/form-core/src/FieldApi.ts:774](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L774)
[packages/form-core/src/FieldApi.ts:779](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L779)
***
Expand All @@ -436,7 +436,7 @@ Updates the field's errorMap
#### Defined in
[packages/form-core/src/FieldApi.ts:1124](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1124)
[packages/form-core/src/FieldApi.ts:1129](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1129)
***
Expand All @@ -460,7 +460,7 @@ Sets the field metadata.
#### Defined in
[packages/form-core/src/FieldApi.ts:746](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L746)
[packages/form-core/src/FieldApi.ts:751](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L751)
***
Expand Down Expand Up @@ -488,7 +488,7 @@ Sets the field value and run the `change` validator.
#### Defined in
[packages/form-core/src/FieldApi.ts:711](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L711)
[packages/form-core/src/FieldApi.ts:716](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L716)
***
Expand Down Expand Up @@ -523,7 +523,7 @@ Swaps the values at the specified indices.
#### Defined in
[packages/form-core/src/FieldApi.ts:789](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L789)
[packages/form-core/src/FieldApi.ts:794](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L794)
***
Expand All @@ -547,7 +547,7 @@ Updates the field instance with new options.
#### Defined in
[packages/form-core/src/FieldApi.ts:667](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L667)
[packages/form-core/src/FieldApi.ts:672](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L672)
***
Expand All @@ -571,4 +571,4 @@ Validates the field value.
#### Defined in
[packages/form-core/src/FieldApi.ts:1069](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1069)
[packages/form-core/src/FieldApi.ts:1074](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1074)
4 changes: 2 additions & 2 deletions docs/reference/functions/isstandardschemavalidator.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: isStandardSchemaValidator
# Function: isStandardSchemaValidator()

```ts
function isStandardSchemaValidator(validator): validator is StandardSchema<unknown, unknown>
function isStandardSchemaValidator(validator): validator is StandardSchemaV1
```

## Parameters
Expand All @@ -17,7 +17,7 @@ function isStandardSchemaValidator(validator): validator is StandardSchema<unkno

## Returns

`validator is StandardSchema<unknown, unknown>`
`validator is StandardSchemaV1`

## Defined in

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/functions/standardschemavalidator.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: standardSchemaValidator
# Function: standardSchemaValidator()

```ts
function standardSchemaValidator(params): Validator<unknown, StandardSchema<any, any>>
function standardSchemaValidator(params): Validator<unknown, StandardSchemaV1>
```

## Parameters
Expand All @@ -17,7 +17,7 @@ function standardSchemaValidator(params): Validator<unknown, StandardSchema<any,

## Returns

`Validator`\<`unknown`, `StandardSchema`\<`any`, `any`\>\>
`Validator`\<`unknown`, `StandardSchemaV1`\>

## Defined in

Expand Down
18 changes: 9 additions & 9 deletions docs/reference/interfaces/fieldapioptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ If `true`, always run async validation, even if there are errors emitted during

#### Defined in

[packages/form-core/src/FieldApi.ts:350](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L350)
[packages/form-core/src/FieldApi.ts:355](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L355)

***

Expand All @@ -57,7 +57,7 @@ The default time to debounce async validation if there is not a more specific de

#### Defined in

[packages/form-core/src/FieldApi.ts:346](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L346)
[packages/form-core/src/FieldApi.ts:351](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L351)

***

Expand All @@ -75,7 +75,7 @@ An optional object with default metadata for the field.

#### Defined in

[packages/form-core/src/FieldApi.ts:368](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L368)
[packages/form-core/src/FieldApi.ts:373](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L373)

***

Expand All @@ -93,7 +93,7 @@ An optional default value for the field.

#### Defined in

[packages/form-core/src/FieldApi.ts:342](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L342)
[packages/form-core/src/FieldApi.ts:347](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L347)

***

Expand All @@ -105,7 +105,7 @@ form: FormApi<TParentData, TFormValidator>;

#### Defined in

[packages/form-core/src/FieldApi.ts:401](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L401)
[packages/form-core/src/FieldApi.ts:406](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L406)

***

Expand All @@ -123,7 +123,7 @@ A list of listeners which attach to the corresponding events

#### Defined in

[packages/form-core/src/FieldApi.ts:372](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L372)
[packages/form-core/src/FieldApi.ts:377](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L377)

***

Expand All @@ -141,7 +141,7 @@ The field name. The type will be `DeepKeys<TParentData>` to ensure your name is

#### Defined in

[packages/form-core/src/FieldApi.ts:338](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L338)
[packages/form-core/src/FieldApi.ts:343](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L343)

***

Expand All @@ -159,7 +159,7 @@ A validator provided by an extension, like `yupValidator` from `@tanstack/yup-fo

#### Defined in

[packages/form-core/src/FieldApi.ts:354](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L354)
[packages/form-core/src/FieldApi.ts:359](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L359)

***

Expand All @@ -177,4 +177,4 @@ A list of validators to pass to the field

#### Defined in

[packages/form-core/src/FieldApi.ts:358](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L358)
[packages/form-core/src/FieldApi.ts:363](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L363)
8 changes: 4 additions & 4 deletions docs/reference/interfaces/fieldlisteners.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ optional onBlur: FieldListenerFn<TParentData, TName, TFieldValidator, TFormValid

#### Defined in

[packages/form-core/src/FieldApi.ts:298](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L298)
[packages/form-core/src/FieldApi.ts:303](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L303)

***

Expand All @@ -39,7 +39,7 @@ optional onChange: FieldListenerFn<TParentData, TName, TFieldValidator, TFormVal

#### Defined in

[packages/form-core/src/FieldApi.ts:291](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L291)
[packages/form-core/src/FieldApi.ts:296](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L296)

***

Expand All @@ -51,7 +51,7 @@ optional onMount: FieldListenerFn<TParentData, TName, TFieldValidator, TFormVali

#### Defined in

[packages/form-core/src/FieldApi.ts:305](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L305)
[packages/form-core/src/FieldApi.ts:310](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L310)

***

Expand All @@ -63,4 +63,4 @@ optional onSubmit: FieldListenerFn<TParentData, TName, TFieldValidator, TFormVal

#### Defined in

[packages/form-core/src/FieldApi.ts:312](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L312)
[packages/form-core/src/FieldApi.ts:317](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L317)
Loading

0 comments on commit df0fb00

Please sign in to comment.