Type

AsyncValidatorConfig

@ng-forge/dynamic-forms

Async custom validator configuration using Angular's validateAsync API. Returns Observable<ValidationError | ValidationError[] | null>.

Two mutually exclusive authoring forms: - functionName: name of a function registered in customFnConfig.asyncValidators. JSON-serializable; suitable for configs loaded from APIs, databases, or OpenAPI. - fn: inline async validator. NOT JSON-serializable; for code-only configs.

Exactly one of functionName or fn must be set.

Signature

type AsyncValidatorConfig =
  | (AsyncValidatorConfigShared & {
      /** Name of registered async validator function */
      functionName: string;
      /** Inline form is forbidden when `functionName` is set */
      fn?: never;
    })
  | (AsyncValidatorConfigShared & {
      /**
       * Inline async validator. Mutually exclusive with `functionName`.
       *
       * NOT JSON-serializable — for code-only configs. For configs loaded
       * from JSON / OpenAPI / databases, use `functionName` to reference
       * a validator registered in `customFnConfig.asyncValidators`.
       */
      fn: AsyncCustomValidator;
      /** Registered form is forbidden when `fn` is set */
      functionName?: never;
    });