it-drain

Empties an async iterator

About

Mostly useful for tests or when you want to be explicit about consuming an iterable without doing anything with any yielded values.

Example

import drain from 'it-drain'

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

drain(values)

Async sources must be awaited:

import drain from 'it-drain'

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

await drain(values())

Install

$ npm i it-drain

Browser `<script>` tag

Loading this module through a script tag will make its exports available as ItDrain in the global namespace.

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

API Docs

https://achingbrain.github.io/it/modules/it-drain.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.

Current Tags

3.0.12 ... latest (7 hours ago)