function-batch

1.1.2 • Public • Published

function-batch

NPM version NPM downloads Build Status codecov Dependency Status

Creates a batched function that will batch up all calls to it, and then after a threshold call the original function with all the args combined.

How to Install

npm install function-batch

Usage

import functionBatch from 'function-batch';
 
const returnArr = (arr) => arr;
const returnArrBatched = functionBatch(returnArr);
 
const value = Promise.all([
  returnArrBatched([1]);
  returnArrBatched([2]);
  returnArrBatched([3]);
  returnArrBatched([4]);
])
.then(([a, b, c, d]) => {
// All resolve with the same value.
// a = [1, 2, 3, 4]
// b = [1, 2, 3, 4]
// c = [1, 2, 3, 4]
// d = [1, 2, 3, 4]
});

Currently function-batch only supports batching up arrays. Support for different kinds of args will be added if requested!

Api

function: functionBatch(func, wait, options): Promise<*>

param type required
func Function yes
wait number yes
options Options no

object: Options

param type required
leading boolean no
trailing boolean no
maxWait number no

Readme

Keywords

none

Package Sidebar

Install

npm i function-batch

Weekly Downloads

3

Version

1.1.2

License

MIT

Last publish

Collaborators

  • madou