async-iterable-map
TypeScript icon, indicating that this package has built-in type declarations

2.0.3 • Public • Published

async-iterable-map

Transforms items of an async iterable concurrently

npm Gitlab pipeline status Dependency Status devDependency Status

Like p-map but for AsyncIterables.

If you like this package, be sure to star its repo, and please consider donating.

Usage

import { map } from "async-iterable-map"

map(source, transform, options = {})

Generic type parameters:

  • T = unknown - type of input elements
  • U = unknown - type of output elements

Parameters:

  • source: AsyncIterable<T> | Iterable<T> - the iterable to transform
  • transform: (element: T) => Promise<U> | U - the transform / mapping function from the input to the output
  • options.concurrency: number - how many elements to transform concurrently. Must be a positive integer or Infinity. Default: Infinity

Returns:

  • AsyncIterableIterator<U> & PromiseLike<U[]>
    • Use the AsyncIterableIterator<U> interface to iterate through the remaining output elements one by one.
    • Use the PromiseLike<U[]> interface to get all of the remaining output elements.

Both interfaces return the output elements in order.

Transforms items of an async iterable concurrently.

Dependencies (1)

Dev Dependencies (3)

Package Sidebar

Install

npm i async-iterable-map

Weekly Downloads

7

Version

2.0.3

License

MIT

Unpacked Size

11.8 kB

Total Files

12

Last publish

Collaborators

  • seangenabe