ai-filter

ai-filter

Filter over async iterables.

This method creates a new async iterable with all elements that pass the test implemented by the provided function.

Async iterable fun

This module is part of Async iterable fun, a complete toolset of modules to work with async iterables.

Usage

This example read a text file, filtering only chunks containing a new line:

import filter from 'ai-filter';
import { createReadStream } from "fs";

const stream = createReadStream(`file.txt`, "utf8");
const result = filter(chunk => chunk.contains('\n'), fromStream(stream))
for await (const chunk of result) {
  console.log(chunk);
}

API

index

The filter() method creates a new async iterable with all elements that pass the test implemented by the provided function.

Parameters

• predicate Function is a predicate, to test each element of the async iterable. Return true to keep the element, false otherwise, taking three arguments:

        element: The current element being processed in the async iterable.
        index: The index of the current element being processed in the async iterable.
        iterable: The async iterable filter was called upon.

• data AsyncIterable The source async iterable to filter.

Returns AsyncIterable A new async iterable with the elements that pass the test.

Install

With npm installed, run

npm install --save ai-filter

See Also

• noffle/common-readme
• parro-it/ai-fun

License

MIT