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

createValidators.md

58 lines2.2 KB

function createValidators<TFormData, TContextValue, TOptions>(options): <TRuns>(...runs) => ValidatorsFromOptionsAndRuns<TFormData, TContextValue, TOptions, TRuns>;

Defined in: validation.public.ts:225

Creates a reusable configuration for an ordered set of validators.

Type Parameters

TFormData

TFormData = any

Library-managed. Do not specify explicitly.

TContextValue

TContextValue = TFormData

Library-managed. Do not specify explicitly.

TOptions

TOptions extends readonly [ValidatorOptions<TFormData, TContextValue, ConfigurableValidationTrigger, ValidatorScope>, ValidatorOptions<TFormData, TContextValue, ConfigurableValidationTrigger, ValidatorScope>] = readonly [ValidatorOptions<TFormData, TContextValue, ConfigurableValidationTrigger, ValidatorScope>, ValidatorOptions<TFormData, TContextValue, ConfigurableValidationTrigger, ValidatorScope>]

Library-managed. Do not specify explicitly.

Parameters

options

TOptions

A nonempty tuple of configurations, one per validator.

Returns

A function that accepts one validation function or Standard Schema per configuration, in the same order. Its TRuns type argument is library-managed. Do not specify it explicitly.

<TRuns>(...runs) => ValidatorsFromOptionsAndRuns<TFormData, TContextValue, TOptions, TRuns>

Example

const withChecks = createValidators([
  { triggers: ['change'] },
  { triggers: ['blur'], bailIfInvalid: true },
])
const validators = withChecks(schema, () => 'Additional check failed')