HttpValidatorOptions — Angular

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

API

interface HttpValidatorOptions<TValue, TResult, TPathKind extends PathKind = PathKind.Root> {
  readonly request: ((ctx: FieldContext<TValue, TPathKind>) => string | undefined) | ((ctx: FieldContext<TValue, TPathKind>) => HttpResourceRequest | undefined);
  readonly onSuccess: MapToErrorsFn<TValue, TResult, TPathKind>;
  readonly onError: (error: unknown, ctx: FieldContext<TValue, TPathKind>) => TreeValidationResult;
  readonly options?: HttpResourceOptions<TResult, unknown> | undefined;
  readonly debounce?: DebounceTimer<string | HttpResourceRequest | undefined> | undefined;
  readonly when?: NoInfer<LogicFn<TValue, boolean, TPathKind>> | undefined;
}

request

((ctx: FieldContext<TValue, TPathKind>) => string | undefined) | ((ctx: FieldContext<TValue, TPathKind>) => HttpResourceRequest | undefined)

Функция, которая получает контекст поля и возвращает URL или запрос для httpResource. Если задан URL, httpResource выполнит для него HTTP-запрос GET.

onSuccess

MapToErrorsFn<TValue, TResult, TPathKind>

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

onError

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

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

options

HttpResourceOptions<TResult, unknown> | undefined

Параметры, используемые при создании httpResource.

debounce

DebounceTimer<string | HttpResourceRequest | undefined> | undefined

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

when

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

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