AsyncValidatorOptions — Angular

Параметры, определяющие, как создать ресурс для асинхронной проверки поля и сопоставить его результат с ошибками проверки.

API

interface AsyncValidatorOptions<TValue, TParams, TResult, TPathKind extends PathKind = PathKind.Root> {
  readonly params: (ctx: FieldContext<TValue, TPathKind>) => TParams;
  readonly debounce?: DebounceTimer<TParams | undefined> | undefined;
  readonly factory: (params: Signal<TParams | undefined>) => ResourceRef<TResult | undefined>;
  readonly onError: (error: unknown, ctx: FieldContext<TValue, TPathKind>) => TreeValidationResult;
  readonly onSuccess: MapToErrorsFn<TValue, TResult, TPathKind>;
  readonly when?: NoInfer<LogicFn<TValue, boolean, TPathKind>> | undefined;
}

params

(ctx: FieldContext<TValue, TPathKind>) => TParams

Функция, которая получает контекст поля и возвращает параметры ресурса.

debounce

DebounceTimer<TParams | undefined> | undefined

Время ожидания в миллисекундах перед запуском асинхронной операции или функция, возвращающая промис, который разрешается, когда можно продолжить обновление.

factory

(params: Signal<TParams | undefined>) => ResourceRef<TResult | undefined>

Функция, которая получает параметры ресурса и возвращает ресурс с указанными параметрами. Для создания ресурса следует использовать указанные параметры без изменений. Система форм сообщит параметры как undefined, если эту проверку выполнять не нужно.

onError

(error: unknown, ctx: FieldContext<TValue, TPathKind>) => TreeValidationResult

Функция для обработки ошибок, возникающих в httpResource (ошибок HTTP, сетевых ошибок и т. д.). Получает ошибку и контекст поля, возвращает список ошибок проверки.

onSuccess

MapToErrorsFn<TValue, TResult, TPathKind>

Функция, которая получает результат ресурса и текущий контекст поля и сопоставляет их со списком ошибок проверки.

when

NoInfer<LogicFn<TValue, boolean, TPathKind>> | undefined

Функция, которая получает контекст поля и возвращает true, если нужно выполнить асинхронную проверку.