Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

standardSchemaValidators.md

73 lines1.6 KB

1---
2id: standardSchemaValidators
3title: standardSchemaValidators
4---
5​
6# Variable: standardSchemaValidators
7​
8```ts
9const standardSchemaValidators: object;
10```
11​
12Defined in: [packages/form-core/src/standardSchemaValidator.ts:73](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L73)
13​
14## Type Declaration
15​
16### validate()
17​
18```ts
19validate<TSource>(__namedParameters, schema):
20 | TStandardSchemaValidatorIssue<TSource>
21 | undefined;
22```
23​
24#### Type Parameters
25​
26##### TSource
27​
28`TSource` *extends* [`ValidationSource`](../type-aliases/ValidationSource.md) = [`ValidationSource`](../type-aliases/ValidationSource.md)
29​
30#### Parameters
31​
32##### \_\_namedParameters
33​
34[`TStandardSchemaValidatorValue`](../type-aliases/TStandardSchemaValidatorValue.md)\<`unknown`, `TSource`\>
35​
36##### schema
37​
38[`StandardSchemaV1`](../type-aliases/StandardSchemaV1.md)
39​
40#### Returns
41​
42 \| [`TStandardSchemaValidatorIssue`](../type-aliases/TStandardSchemaValidatorIssue.md)\<`TSource`\>
43 \| `undefined`
44​
45### validateAsync()
46​
47```ts
48validateAsync<TSource>(__namedParameters, schema): Promise<
49 | TStandardSchemaValidatorIssue<TSource>
50| undefined>;
51```
52​
53#### Type Parameters
54​
55##### TSource
56​
57`TSource` *extends* [`ValidationSource`](../type-aliases/ValidationSource.md)
58​
59#### Parameters
60​
61##### \_\_namedParameters
62​
63[`TStandardSchemaValidatorValue`](../type-aliases/TStandardSchemaValidatorValue.md)\<`unknown`, `TSource`\>
64​
65##### schema
66​
67[`StandardSchemaV1`](../type-aliases/StandardSchemaV1.md)
68​
69#### Returns
70​
71`Promise`\<
72 \| [`TStandardSchemaValidatorIssue`](../type-aliases/TStandardSchemaValidatorIssue.md)\<`TSource`\>
73 \| `undefined`\>