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

FieldValidatorContext.md

100 lines2.1 KB

Defined in: validation.public.ts:942

Values and helpers passed to a field validation function.

Type Parameters

TFieldName

TFieldName

Library-managed. Do not specify explicitly.

TFieldValue

TFieldValue

Library-managed. Do not specify explicitly.

TFormData

TFormData

Library-managed. Do not specify explicitly.

Properties

event

event: ValidationTrigger;

Defined in: validation.public.ts:948

The event that caused this validation run.


fieldApi

fieldApi: FieldApi<TFieldName, TFieldValue, any, TFormData, any>;

Defined in: validation.public.ts:954

The field being validated, including when a watched field caused the event.


formApi

formApi: FormApi<TFormData, any>;

Defined in: validation.public.ts:952

The owning form. Read other field values here for cross-field validation.


parseIssues

parseIssues: ParseFieldIssuesFn;

Defined in: validation.public.ts:958

Converts Standard Schema issues into errors for this field, without routing their paths.


signal

signal: AbortSignal;

Defined in: validation.public.ts:950

Aborted when this run is cancelled. Pass it to asynchronous work such as fetch.


value

value: TFieldValue;

Defined in: validation.public.ts:956

The current value of the field being validated.