Skip to content

Commit f958be9

Browse files
ci: apply automated fixes and generate docs
1 parent 6b8aa1e commit f958be9

10 files changed

Lines changed: 44 additions & 13 deletions

File tree

docs/reference/classes/FieldApi.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ Use `field.state.value` instead.
305305
handleBlur(): void;
306306
```
307307
308-
Defined in: [packages/form-core/src/FieldApi.ts:2031](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L2031)
308+
Defined in: [packages/form-core/src/FieldApi.ts:2035](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L2035)
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:2024](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L2024)
324+
Defined in: [packages/form-core/src/FieldApi.ts:2028](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L2028)
325325
326326
Handles the change event.
327327
@@ -435,7 +435,7 @@ parseValueWithSchema(schema):
435435
| undefined;
436436
```
437437
438-
Defined in: [packages/form-core/src/FieldApi.ts:2074](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L2074)
438+
Defined in: [packages/form-core/src/FieldApi.ts:2078](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L2078)
439439
440440
Parses the field's value with the given schema and returns
441441
issues (if any). This method does NOT set any internal errors.
@@ -463,7 +463,7 @@ parseValueWithSchemaAsync(schema): Promise<
463463
| undefined>;
464464
```
465465
466-
Defined in: [packages/form-core/src/FieldApi.ts:2086](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L2086)
466+
Defined in: [packages/form-core/src/FieldApi.ts:2090](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L2090)
467467
468468
Parses the field's value with the given schema and returns
469469
issues (if any). This method does NOT set any internal errors.
@@ -575,7 +575,7 @@ Replaces a value at the specified index.
575575
setErrorMap(errorMap): void;
576576
```
577577
578-
Defined in: [packages/form-core/src/FieldApi.ts:2047](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L2047)
578+
Defined in: [packages/form-core/src/FieldApi.ts:2051](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L2051)
579579
580580
Updates the field's errorMap
581581
@@ -700,7 +700,7 @@ Updates the field instance with new options.
700700
validate(cause, opts?): unknown[] | Promise<unknown[]>;
701701
```
702702
703-
Defined in: [packages/form-core/src/FieldApi.ts:1991](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1991)
703+
Defined in: [packages/form-core/src/FieldApi.ts:1995](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1995)
704704
705705
Validates the field value.
706706

docs/reference/functions/createFieldMap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: createFieldMap
99
function createFieldMap<T>(values): { [K in string | number | symbol]: K };
1010
```
1111

12-
Defined in: [packages/form-core/src/utils.ts:541](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L541)
12+
Defined in: [packages/form-core/src/utils.ts:543](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L543)
1313

1414
## Type Parameters
1515

docs/reference/functions/deepCopy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: deepCopy
99
function deepCopy<T>(obj): T;
1010
```
1111

12-
Defined in: [packages/form-core/src/utils.ts:621](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L621)
12+
Defined in: [packages/form-core/src/utils.ts:623](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L623)
1313

1414
## Type Parameters
1515

docs/reference/functions/evaluate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: evaluate
99
function evaluate<T>(objA, objB): boolean;
1010
```
1111

12-
Defined in: [packages/form-core/src/utils.ts:424](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L424)
12+
Defined in: [packages/form-core/src/utils.ts:426](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L426)
1313

1414
## Type Parameters
1515

docs/reference/functions/isGlobalFormValidationError.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: isGlobalFormValidationError
99
function isGlobalFormValidationError(error): error is GlobalFormValidationError<unknown>;
1010
```
1111

12-
Defined in: [packages/form-core/src/utils.ts:418](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L418)
12+
Defined in: [packages/form-core/src/utils.ts:420](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L420)
1313

1414
## Parameters
1515

docs/reference/functions/uuid.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: uuid
99
function uuid(): string;
1010
```
1111

12-
Defined in: [packages/form-core/src/utils.ts:580](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L580)
12+
Defined in: [packages/form-core/src/utils.ts:582](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L582)
1313

1414
## Returns
1515

docs/reference/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ title: "@tanstack/form-core"
3131
- [TupleDeepKeyAndValue](interfaces/TupleDeepKeyAndValue.md)
3232
- [UnknownDeepKeyAndValue](interfaces/UnknownDeepKeyAndValue.md)
3333
- [ValidationLogicProps](interfaces/ValidationLogicProps.md)
34+
- [ValidationLogicValidatorsFn](interfaces/ValidationLogicValidatorsFn.md)
3435

3536
## Type Aliases
3637

docs/reference/interfaces/ValidationLogicProps.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,9 @@ Defined in: [packages/form-core/src/ValidationLogic.ts:33](https://github.com/Ta
6565

6666
###### validators
6767

68-
(`ValidationLogicValidatorsFn` \| `undefined`)[]
68+
(
69+
\| [`ValidationLogicValidatorsFn`](ValidationLogicValidatorsFn.md)
70+
\| `undefined`)[]
6971

7072
#### Returns
7173

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
id: ValidationLogicValidatorsFn
3+
title: ValidationLogicValidatorsFn
4+
---
5+
6+
# Interface: ValidationLogicValidatorsFn
7+
8+
Defined in: [packages/form-core/src/ValidationLogic.ts:3](https://github.com/TanStack/form/blob/main/packages/form-core/src/ValidationLogic.ts#L3)
9+
10+
## Properties
11+
12+
### cause
13+
14+
```ts
15+
cause: "change" | "blur" | "submit" | "mount" | "server" | "dynamic";
16+
```
17+
18+
Defined in: [packages/form-core/src/ValidationLogic.ts:17](https://github.com/TanStack/form/blob/main/packages/form-core/src/ValidationLogic.ts#L17)
19+
20+
***
21+
22+
### fn
23+
24+
```ts
25+
fn: any;
26+
```
27+
28+
Defined in: [packages/form-core/src/ValidationLogic.ts:5](https://github.com/TanStack/form/blob/main/packages/form-core/src/ValidationLogic.ts#L5)

docs/reference/variables/throttleFormState.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: throttleFormState
99
const throttleFormState: (...args) => void;
1010
```
1111

12-
Defined in: [packages/form-core/src/utils.ts:608](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L608)
12+
Defined in: [packages/form-core/src/utils.ts:610](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L610)
1313

1414
## Parameters
1515

0 commit comments

Comments
 (0)