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

createValidator.md

46 lines1.2 KB

function createValidator<TOptions>(options): <TValidator>(run) => CreatedValidator<TOptions, TValidator>;

Defined in: validation.public.ts:195

Creates a reusable configuration to apply to validation functions or Standard Schemas.

Type Parameters

TOptions

TOptions extends ValidatorOptions<any, any, ConfigurableValidationTrigger, ValidatorScope>

Library-managed. Do not specify explicitly.

Parameters

options

TOptions

Returns

A function that combines options with its run argument, preserving the validator's inferred types. Its TValidator type argument is library-managed. Do not specify it explicitly.

<TValidator>(run) => CreatedValidator<TOptions, TValidator>

Example

const afterSubmit = createValidator({
  triggers: [{
    trigger: 'change',
    when: ({ formApi }) => formApi.state.submissionAttempts > 0,
  }],
})
const validators = [afterSubmit(schema)]