Function takeUntil

takeUntil<TElement, TFiltered>(
source: Iterable<TElement>,
predicate: IndexedTypePredicate<TElement, TFiltered>,
): IEnumerable<TFiltered>
Returns consecutive leading elements until a type guard predicate returns true, then stops.
Type Parameters
- TElement
  Type of elements within source.
- TFiltered
  extends TElement Result type produced by predicate.
Parameters
- source: Iterable<TElement>
  The source iterable.
- predicate: IndexedTypePredicate<TElement, TFiltered>
  Type guard invoked for each element and its zero-based index; iteration halts immediately when it returns true.
Returns IEnumerable<TFiltered>
A deferred sequence containing the contiguous prefix produced before predicate succeeds.
Remarks
Elements after the first element satisfying predicate are not inspected.
Example
```
const mixed: (number | string)[] = [1, 2, 'stop', 3];
const beforeStop = takeUntil(mixed, (x): x is string => typeof x === 'string').toArray();
console.log(beforeStop); // [1, 2]
```
- Defined in src/enumerator/functions/takeUntil.ts:20
takeUntil<TElement>(
source: Iterable<TElement>,
predicate: IndexedPredicate<TElement>,
): IEnumerable<TElement>
Returns consecutive leading elements until a predicate returns true, then stops.
Type Parameters
- TElement
  Type of elements within source.
Parameters
- source: Iterable<TElement>
  The source iterable.
- predicate: IndexedPredicate<TElement>
  Predicate invoked for each element and its zero-based index; iteration halts immediately when it returns true.
Returns IEnumerable<TElement>
A deferred sequence containing the contiguous prefix produced before predicate succeeds.
Remarks
Elements after the first element satisfying predicate are not inspected.
Example
```
const numbers = [1, 2, 3, 4, 5];
const taken = takeUntil(numbers, x => x > 3).toArray();
console.log(taken); // [1, 2, 3]
```
- Defined in src/enumerator/functions/takeUntil.ts:39

Function takeUntil

Type Parameters

Parameters

Returns IEnumerable<TFiltered>

Remarks

Example

Type Parameters

Parameters

Returns IEnumerable<TElement>

Remarks

Example

Settings