it-filter

Filters the passed iterable by using the filter function

About

Filter values out of an (async)iterable

Example

import all from 'it-all'
import filter from 'it-filter'

// This can also be an iterator, generator, etc
const values = [0, 1, 2, 3, 4]

const fn = (val, index) => val > 2 // Return boolean to keep item

const arr = all(filter(values, fn))

console.info(arr) // 3, 4

Async sources and filter functions must be awaited:

import all from 'it-all'
import filter from 'it-filter'

const values = async function * () {
  yield * [0, 1, 2, 3, 4]
}

const fn = async val => (val, index) > 2 // Return boolean or promise of boolean to keep item

const arr = await all(filter(values, fn))

console.info(arr) // 3, 4

Install

$ npm i it-filter

Browser <script> tag

Loading this module through a script tag will make it's exports available as ItFilter in the global namespace.

<script src="https://unpkg.com/it-filter/dist/index.min.js"></script>

API Docs

• https://achingbrain.github.io/it/modules/it_filter.html

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.