@lou.codes/iterables
Version:
🔁 Iterable and AsyncIterable utils
27 lines (26 loc) • 846 B
JavaScript
import { createIterableIterator } from "./createIterableIterator.js";
/**
* Filters items in an iterable against a predicate and returns items that
* evaluated to `true`.
*
* @category Generators
* @example
* ```typescript
* const filterEven = filter((number: number) => number % 2 === 0);
*
* iterableToArray(filterEven([1, 2, 3, 4])); // [2, 4]
* iterableToArray(filterEven([1, 3, 5, 7])); // []
* ```
* @param predicate Predicate function to evaluate each item.
* @returns Curried function with `predicate` set in context.
*/
export const filter = predicate => iterable =>
createIterableIterator(function* () {
// eslint-disable-next-line functional/no-loop-statements
for (const item of iterable) {
// eslint-disable-next-line functional/no-conditional-statements
if (predicate(item)) {
yield item;
}
}
});