Function span

span<TElement, TFiltered>(
source: Iterable<TElement>,
predicate: TypePredicate<TElement, TFiltered>,
): [IEnumerable<TFiltered>, IEnumerable<TElement>]
Splits the sequence into the maximal leading span that satisfies a type guard and the remaining elements.
Type Parameters
- TElement
  Type of elements within the source iterable.
- TFiltered
  extends TElement Narrowed element type produced when predicate returns true.
Parameters
- source: Iterable<TElement>
  The source iterable.
- predicate: TypePredicate<TElement, TFiltered>
  Type guard evaluated for each element until it first returns false.
Returns [IEnumerable<TFiltered>, IEnumerable<TElement>]
A tuple containing the contiguous matching prefix and the remainder of the sequence.
Remarks
source is fully enumerated immediately and buffered so both partitions can be iterated repeatedly without re-evaluating predicate.
Example
```
const numbers = [1, 2, 3, 4, 1, 2];
const [first, second] = span(numbers, x => x < 3);
console.log(first.toArray()); // [1, 2]
console.log(second.toArray()); // [3, 4, 1, 2]
```
- Defined in src/enumerator/functions/span.ts:21
span<TElement>(
source: Iterable<TElement>,
predicate: Predicate<TElement>,
): [IEnumerable<TElement>, IEnumerable<TElement>]
Splits the sequence into the maximal leading span that satisfies a predicate and the remaining elements.
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 until it first returns false.
Returns [IEnumerable<TElement>, IEnumerable<TElement>]
A tuple containing the contiguous matching prefix and the remainder of the sequence.

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

Function span

Type Parameters

Parameters

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

Remarks

Example

Type Parameters

Parameters

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

Remarks

Settings