Function filter

filter<T>(predicate: ((arg: T) => boolean), iterable: Iterable<T>): IterableIterator<T>
Removes values that fail to satisfy the supplied predicate from the supplied iterable.
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 or a promise that resolves to a boolean.
  - - (arg: T): boolean
    - Parameters
      
      arg: T
      
      Returns boolean
- iterable: Iterable<T>
Returns IterableIterator<T>
- Defined in src/index.ts:188
filter<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:193
filter<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:198

Generated using TypeDoc