Skip to main content

Variable: flatMapAsync()

const flatMapAsync: {<From, To>(fn): (asyncIterable) => AsyncIterable<To>; <From, To>(fn, asyncIterable): AsyncIterable<To>; <From, To>(fn): (asyncIterable) => AsyncIterable<To>; <From, To>(fn, asyncIterable): AsyncIterable<To>; }

Defined in: transforms.d.ts:183

Returns an async iterable containing the values of the async iterables returned, or resolving from promises returned, from applying fn to each value of asyncIterable in iteration order.

Like Array.prototype.flatMap, but for async iterables.

Call Signature​

<From, To>(fn): (asyncIterable) => AsyncIterable<To>

Type Parameters​

From​

From

To​

To extends [] | unknown[]

Parameters​

fn​

(value) => MaybePromiseLike<AsyncIterable<To, any, any> | Iterable<To, any, any>>

Returns​

(asyncIterable): AsyncIterable<To>

Parameters​

asyncIterable​

AsyncIterable<From>

Returns​

AsyncIterable<To>

Call Signature​

<From, To>(fn, asyncIterable): AsyncIterable<To>

Type Parameters​

From​

From

To​

To extends [] | unknown[]

Parameters​

fn​

(value) => MaybePromiseLike<AsyncIterable<To, any, any> | Iterable<To, any, any>>

asyncIterable​

AsyncIterable<From>

Returns​

AsyncIterable<To>

Call Signature​

<From, To>(fn): (asyncIterable) => AsyncIterable<To>

Type Parameters​

From​

From

To​

To

Parameters​

fn​

(value) => MaybePromiseLike<AsyncIterable<To, any, any> | Iterable<To, any, any>>

Returns​

(asyncIterable): AsyncIterable<To>

Parameters​

asyncIterable​

AsyncIterable<From>

Returns​

AsyncIterable<To>

Call Signature​

<From, To>(fn, asyncIterable): AsyncIterable<To>

Type Parameters​

From​

From

To​

To

Parameters​

fn​

(value) => MaybePromiseLike<AsyncIterable<To, any, any> | Iterable<To, any, any>>

asyncIterable​

AsyncIterable<From>

Returns​

AsyncIterable<To>

Example​

console.log(
  await pipe(
    asAsync([`sloth`, `more sloth`, `even more sloth`]),
    flatMapAsync(string => [string, string.length]),
    reduceAsync(toArray()),
  ),
)
//=> [ 'sloth', 5, 'more sloth', 10, 'even more sloth', 15 ]

Since​

v0.0.1