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

createValidators.md

58 lines2.2 KB

1---
2id: createValidators
3title: createValidators
4---
5​
6```ts
7function createValidators<TFormData, TContextValue, TOptions>(options): <TRuns>(...runs) => ValidatorsFromOptionsAndRuns<TFormData, TContextValue, TOptions, TRuns>;
8```
9​
10Defined in: [validation.public.ts:225](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L225)
11​
12Creates a reusable configuration for an ordered set of validators.
13​
14## Type Parameters
15​
16### TFormData
17​
18`TFormData` = `any`
19​
20Library-managed. Do not specify explicitly.
21​
22### TContextValue
23​
24`TContextValue` = `TFormData`
25​
26Library-managed. Do not specify explicitly.
27​
28### TOptions
29​
30`TOptions` *extends* readonly \[[`ValidatorOptions`](../type-aliases/ValidatorOptions.md)\<`TFormData`, `TContextValue`, [`ConfigurableValidationTrigger`](../type-aliases/ConfigurableValidationTrigger.md), [`ValidatorScope`](../type-aliases/ValidatorScope.md)\>, [`ValidatorOptions`](../type-aliases/ValidatorOptions.md)\<`TFormData`, `TContextValue`, [`ConfigurableValidationTrigger`](../type-aliases/ConfigurableValidationTrigger.md), [`ValidatorScope`](../type-aliases/ValidatorScope.md)\>\] = readonly \[[`ValidatorOptions`](../type-aliases/ValidatorOptions.md)\<`TFormData`, `TContextValue`, [`ConfigurableValidationTrigger`](../type-aliases/ConfigurableValidationTrigger.md), [`ValidatorScope`](../type-aliases/ValidatorScope.md)\>, [`ValidatorOptions`](../type-aliases/ValidatorOptions.md)\<`TFormData`, `TContextValue`, [`ConfigurableValidationTrigger`](../type-aliases/ConfigurableValidationTrigger.md), [`ValidatorScope`](../type-aliases/ValidatorScope.md)\>\]
31​
32Library-managed. Do not specify explicitly.
33​
34## Parameters
35​
36### options
37​
38`TOptions`
39​
40A nonempty tuple of configurations, one per validator.
41​
42## Returns
43​
44A function that accepts one validation function or Standard Schema
45per configuration, in the same order. Its `TRuns` type argument is library-managed.
46Do not specify it explicitly.
47​
48\<`TRuns`\>(...`runs`) => `ValidatorsFromOptionsAndRuns`\<`TFormData`, `TContextValue`, `TOptions`, `TRuns`\>
49​
50## Example
51​
52```ts
53const withChecks = createValidators([
54 { triggers: ['change'] },
55 { triggers: ['blur'], bailIfInvalid: true },
56])
57const validators = withChecks(schema, () => 'Additional check failed')
58```