aggregate-async-iterator

aggregate-async-iterator

Aggregates several async iterators into one (zip)

usage

import { aggregateRoundRobin, aggregateFifo } from "aggregate-async-iterator";

async function* sequence(name, time = 100, num = 10) {
  for (let i = 0; i < num; i += 1) {
    yield new Promise(resolve => setTimeout(resolve(name + i), time));
  }
}

console.log("RR:");

for await (const r of aggregateRoundRobin([
    sequence("A", 100, 3),
    sequence("B", 35, 5)
  ])) {
  console.log(r);
}

console.log("FIFO:");

for await (const r of aggregateFifo([
    sequence("A", 100, 3),
    sequence("B", 35, 5)
  ])) {
  console.log(r);
}

Prints interleaved sequences

RR:
A0
B0
A1
B1
A2
B2
B3
B4
FIFO:
A0
B0
A1
B1
A2
B2
B3
B4

API

Table of Contents

• aggregateFifo
  • Parameters
• aggregateRoundRobin
  • Parameters

aggregateFifo

Aggregate items from sevaral async iterators into one. Items are collected first in first out from the sources. Whatever source comes first will be delivered first.

Parameters

• sources Array<AsyncIterator<any>>

Returns AsyncIterable<any> items collected from all sources

aggregateRoundRobin

Aggregate items from sevaral async iterators into one. Items are collected round robin from the sources. The 2nd. round of items will only be delivered after all sources have delivered their 1st. round (or reached their end).

Parameters

• sources Array<AsyncIterator<any>>

Returns AsyncIterable<any> items collected from all sources

install

With npm do:

npm install aggregate-async-iterator

license

BSD-2-Clause