Variable filterArray`Const`

filterArray: TOperation<
    IFilterArrayOperationData,
    Omit<
        IFilterArrayOperationData,
        "filterProperty"
        | "filterValue"
        | "filterPredicate",
    >,
> = ...

Filters an array based on property equality or custom predicate function.

Operates on arrayData passed from previous operations. Supports two filtering modes:

Property equality: filterProperty and filterValue to filter by property match
Custom predicate: filterPredicate function for complex filtering logic

Returns

Operation data with filteredArray containing filtered results

Example

// Filter by property equality
const result = filterArray({
  arrayData: [{name: 'Alice', age: 25}, {name: 'Bob', age: 30}],
  filterProperty: 'age',
  filterValue: 25
});
// result.filteredArray = [{name: 'Alice', age: 25}]

Example

// Filter with custom predicate
const result = filterArray({
  arrayData: [1, 2, 3, 4, 5],
  filterPredicate: (item) => item % 2 === 0
});
// result.filteredArray = [2, 4]