@angular/forms/signals

aggregateProperty

function

Adds a value to an AggregateProperty of a field.

API

function aggregateProperty<
  TValue,
  TPropItem,
  TPathKind extends PathKind = PathKind.Root,
>(
  path: FieldPath<TValue, TPathKind>,
  prop: AggregateProperty<any, TPropItem>,
  logic: NoInfer<LogicFn<TValue, TPropItem, TPathKind>>,
): void;

aggregateProperty

void

Adds a value to an AggregateProperty of a field.

@parampathFieldPath<TValue, TPathKind>

The target path to set the aggregate property on.

@parampropAggregateProperty<any, TPropItem>

The aggregate property

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

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

@returnsvoid