Function partition

partition<TElement, TFiltered>(
source: Iterable<TElement>,
predicate: TypePredicate<TElement, TFiltered>,
): [IEnumerable<TFiltered>, IEnumerable<Exclude<TElement, TFiltered>>]
Splits the sequence into cached partitions using a type guard predicate.
Type Parameters
- TElement
  Type of elements within the source iterable.
- TFiltered
  extends TElement Type produced when predicate narrows an element.
Parameters
- source: Iterable<TElement>
  The source iterable.
- predicate: TypePredicate<TElement, TFiltered>
  Type guard invoked for each element. Elements that satisfy the predicate populate the first partition.
Returns [IEnumerable<TFiltered>, IEnumerable<Exclude<TElement, TFiltered>>]
A tuple containing the matching partition and the partition with the remaining elements.
Remarks
source is fully enumerated immediately and buffered so both partitions can be iterated repeatedly without re-evaluating the predicate.
Example
```
const numbers = [1, 2, 3, 4, 5, 6];
const [evens, odds] = partition(numbers, x => x % 2 === 0);
console.log(evens.toArray()); // [2, 4, 6]
console.log(odds.toArray()); // [1, 3, 5]
```
- Defined in src/enumerator/functions/partition.ts:21
partition<TElement>(
source: Iterable<TElement>,
predicate: Predicate<TElement>,
): [IEnumerable<TElement>, IEnumerable<TElement>]
Splits the sequence into cached partitions using a boolean predicate.
Type Parameters
- TElement
  Type of elements within the source iterable.
Parameters
- source: Iterable<TElement>
  The source iterable.
- predicate: Predicate<TElement>
  Predicate evaluated for each element. Elements for which it returns true populate the first partition.
Returns [IEnumerable<TElement>, IEnumerable<TElement>]
A tuple containing the elements that satisfied predicate and those that did not.

Remarks
source is fully enumerated immediately and buffered so both partitions can be iterated repeatedly without re-evaluating the predicate.
- Defined in src/enumerator/functions/partition.ts:34

Function partition

Type Parameters

Parameters

Returns [IEnumerable<TFiltered>, IEnumerable<Exclude<TElement, TFiltered>>]

Remarks

Example

Type Parameters

Parameters

Returns [IEnumerable<TElement>, IEnumerable<TElement>]

Remarks

Settings