it-merge

Treat one or more iterables as a single iterable

About

Merge several (async)iterables into one, yield values as they arrive.

Nb. sources are iterated over in parallel so the order of emitted items is not guaranteed.

Example

import merge from 'it-merge'
import all from 'it-all'

// This can also be an iterator, generator, etc
const values1 = [0, 1, 2, 3, 4]
const values2 = [5, 6, 7, 8, 9]

const arr = all(merge(values1, values2))

console.info(arr) // 0, 1, 2, 3, 4, 5, 6, 7, 8, 9

Async sources must be awaited:

import merge from 'it-merge'
import all from 'it-all'

// This can also be an iterator, async iterator, generator, etc
const values1 = async function * () {
  yield * [0, 1, 2, 3, 4]
}
const values2 = async function * () {
  yield * [5, 6, 7, 8, 9]
}

const arr = await all(merge(values1(), values2()))

console.info(arr) // 0, 1, 5, 6, 2, 3, 4, 7, 8, 9  <- nb. order is not guaranteed

Install

$ npm i it-merge

Browser `<script>` tag

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

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

API Docs

https://achingbrain.github.io/it/modules/it-merge.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.14 ... latest (13 hours ago)