@angular/forms/signals

validateStandardSchema

function

stablesince v22.0

Validates a field using a StandardSchemaV1 compatible validator (e.g. a Zod validator).

API

function validateStandardSchema<
  TSchema,
  TModel extends IgnoreUnknownProperties<TSchema>,
>(
  path: SchemaPath<TModel> &
    ([TModel] extends [AbstractControl]
      ? CompatSchemaPath<TModel, Root>
      : SchemaPath<TModel, 1, Root>) &
    ([TModel] extends [AbstractControl]
      ? unknown
      : [TModel] extends [readonly any[]]
        ? unknown
        : TModel extends Record<string, any>
          ? { [K in keyof TModel]: MaybeSchemaPathTree<TModel[K], Child> }
          : unknown),
  schema: any,
): void;

@parampath

SchemaPath<TModel> & ([TModel] extends [AbstractControl] ? CompatSchemaPath<TModel, Root> : SchemaPath<TModel, 1, Root>) & ([TModel] extends [AbstractControl] ? unknown : [TModel] extends [readonly any[]] ? unknown : TModel extends Record<string, any> ? { [K in keyof TModel]: MaybeSchemaPathTree<TModel[K], Child>; } : unknown)

The FieldPath to the field to validate.

@paramschemaany

The standard schema compatible validator to use for validation, or a LogicFn that returns the schema.

@returnsvoid

Description

Validates a field using a StandardSchemaV1 compatible validator (e.g. a Zod validator).

See https://github.com/standard-schema/standard-schema for more about standard schema.