Skip to content

Latest commit

 

History

History

it-flat-batch

it-flat-batch

codecov CI

Takes an async iterator that emits variable length arrays and emits them as fixed size batches

About

The final batch may be smaller than requested batch size.

Example

import batch from 'it-flat-batch'
import all from 'it-all'

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

const result = all(batch(values, batchSize))

console.info(result) // [0, 1], [2, 3], [4]

Async sources must be awaited:

import batch from 'it-flat-batch'
import all from 'it-all'

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

const result = await all(batch(values(), batchSize))

console.info(result) // [0, 1], [2, 3], [4]

Install

$ npm i it-flat-batch

Browser <script> tag

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

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

API Docs

License

Licensed under either of

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.