conch

micro library for async sequential batches (Node/Browser/Deno)

The Why →

Install

Node

npm i @barelyreaper/conch
# or
yarn add @barelyreaper/conch

Deno

import {conch} from 'https://cdn.skypack.dev/@barelyreaper/conch';
// or
import {conch} from "https://www.unpkg.com/@barelyreaper/conch/dist/index.mjs"
// or 
import {conch} from "https://esm.sh/@barelyreaper/conch"

Usage

Node

const { conch } = require('@barelyreaper/conch')

const data = [
  {
    item: 1,
  },
  {
    item: 2,
  },
  {
    item: 3,
  },
]

function getData(item) {
  return new Promise(resolve => {
    setTimeout(() => {
      resolve(item)
    }, 2500)
  })
}

// Will take 3 * 2500 , considering there's 3 items and only one can run at once (limit:1)
conch(data, getData, { limit: 1 }).then(data => {
  console.log({ data })
})

Deno

import { conch } from "https://esm.sh/@barelyreaper/conch@1.2.0";

const mapper = (item) => {
  return new Promise((resolve) => {
    setTimeout(() => {
      resolve(item * 2);
    }, 3000);
  });
};

const items = [1, 2, 3];

const result = await conch(items, mapper, {
  limit: Math.ceil(items.length / 2),
});

console.log(result); //=>[2,4,6]

Build

yarn # install devDeps
yarn test # check the if the limit is being taken in consideration
yarn build # build the package

Benchmark

BENCHMARKS