Function takeWhile

takeWhile<T>(predicate: ((arg: T) => boolean), iterable: Iterable<T>): IterableIterator<T>
Yields values from the provided iterable while they satisfy the provided predicate.
Type Parameters
Type Parameters
- T
Parameters
- predicate: ((arg: T) => boolean)
  
  A function that takes an element yielded by the provided iterable and returns a boolean.
  - - (arg: T): boolean
    - Parameters
      
      arg: T
      
      Returns boolean
- iterable: Iterable<T>
Returns IterableIterator<T>
- Defined in src/index.ts:1322
takeWhile<T>(predicate: ((arg: T) => boolean), iterable: AsyncIterable<T>): AsyncIterableIterator<T>
Type Parameters
Type Parameters
- T
Parameters
- predicate: ((arg: T) => boolean)
  - - (arg: T): boolean
    - Parameters
      
      arg: T
      
      Returns boolean
- iterable: AsyncIterable<T>
Returns AsyncIterableIterator<T>
- Defined in src/index.ts:1327
takeWhile<T>(predicate: ((arg: T) => boolean), iterable: Iterable<T> | AsyncIterable<T>): IterableIterator<T> | AsyncIterableIterator<T>
Type Parameters
Type Parameters
- T
Parameters
- predicate: ((arg: T) => boolean)
  - - (arg: T): boolean
    - Parameters
      
      arg: T
      
      Returns boolean
- iterable: Iterable<T> | AsyncIterable<T>
Returns IterableIterator<T> | AsyncIterableIterator<T>
- Defined in src/index.ts:1332

Generated using TypeDoc