voxpelli/buffered-async-iterable

Repository files navigation

Buffered parallel processing of async iterables / generators.

npm versionnpm downloadsModule type: ESMTypes in JSneostandard javascript styleFollow @voxpelli@mastodon.social

import { bufferedAsyncMap } from 'buffered-async-iterable';

async function * asyncGenerator() {
  yield ...
}

const mappedIterator = bufferedAsyncMap(asyncGenerator(), async (item) => {
  // Apply additional async lookup / processing
});

for await (const item of mappedIterator) {
  // Consume the buffered async iterable
}
import { bufferedAsyncMap } from 'buffered-async-iterable';

const mappedIterator = bufferedAsyncMap(['foo'], async (item) => {
  // Apply additional async lookup / processing
});

for await (const item of mappedIterator) {
  // Consume the buffered async iterable
}
import { bufferedAsyncMap } from 'buffered-async-iterable';

const mappedIterator = bufferedAsyncMap(['foo'], async function * (item) {
  // Apply additional async lookup / processing
  yield ...
  yield * ...
});

for await (const item of mappedIterator) {
  // Consume the buffered async iterable
}

Iterates and applies the callback to up to bufferSize items from input yielding values as they resolve.

bufferedAsyncMap(input, callback[, { bufferSize=6, ordered=false }]) => AsyncIterableIterator

  • input – either an async iterable, an ordinare iterable or an array
  • callback(item) – should be either an async generator or an ordinary async function. Items from async generators are buffered in the main buffer and the buffer is refilled by the one that has least items in the current buffer (input is considered equal to sub iterators in this regard when refilling the buffer)
  • bufferSizeoptional – defaults to 6, sets the max amount of simultanoeus items that processed at once in the buffer.
  • orderedoptional – defaults to false, when true the result will be returned in order instead of unordered

Merges all given (async) iterables in parallel, returning the values as they resolve

mergeIterables(input[, { bufferSize=6 }]) => AsyncIterableIterator

  • input – an array of async iterables, ordinare iterables and/or arrays
  • bufferSizeoptional – defaults to 6, sets the max amount of simultanoeus items that processed at once in the buffer.

About

Buffered parallel processing of async iterables / generators

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published

Contributors 3

  •  
  •  
  •