Introduction

The in_batches package provides functionality for a given callback function to be applied (synchronously or asynchronously) to batches (of a specified size) of an iterable object.

Installation

This package should be installed via npm. You must have npm installed first. The following can be run on the commandline to install the in_batches package with npm:

npm install @nicolawealth/in_batches

Usage

The 'in_batches' package allows for efficient processing of large data sets in manageable batches to optimize performance and handle asynchronous tasks effectively.

Interface

The package exports the object inBatches with functions: inBatches.sync(elements, size, callback) and inBatches.async(elements, size, callback) which behave in the same manner except that inBatches.async performs it's callback function calls asynchronously. Here elements is an iterable object (such as an array) and size refers to the desired batch size, i.e. the size of the groupings of elements. callback refers to the function which will be applied to each batch of elements where callback is of the form (elements, batchNum) => void. The callback function consumes a subset of elements and a batchNum (0, 1, 2, ...) and does not return anything. If size does not evenly divide elements, the final batch will contain the remainder of elements after division by size and thus will contain less than size items.

Testing

Tests can be found in in_batches.test.ts located in in_batches/src and should be run with sinon, mocha and nyc.