@angular/forms/signals

aggregateMetadata

function

Adds a value to an AggregateMetadataKey of a field.

API

function aggregateMetadata<  TValue,  TMetadataItem,  TPathKind extends PathKind = PathKind.Root,>(  path: SchemaPath<TValue, 1, TPathKind>,  key: AggregateMetadataKey<any, TMetadataItem>,  logic: NoInfer<LogicFn<TValue, TMetadataItem, TPathKind>>,): void;

aggregateMetadata

void

Adds a value to an AggregateMetadataKey of a field.

@parampathSchemaPath<TValue, 1, TPathKind>

The target path to set the aggregate metadata on.

@paramkeyAggregateMetadataKey<any, TMetadataItem>

The aggregate metadata key

@paramlogicNoInfer<LogicFn<TValue, TMetadataItem, TPathKind>>

A function that receives the FieldContext and returns a value to add to the aggregate metadata.

@returnsvoid