Skip to main content

Function: flattenAsync()

flattenAsync<Value>(asyncIterable): AsyncIterable<Value, any, any>

Returns an async iterable that contains the values of each iterable in asyncIterable in iteration order.

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

Type Parameters​

• Value

Parameters​

• asyncIterable: AsyncIterable<Iterable<Value, any, any> | AsyncIterable<Value, any, any>, any, any>

Returns​

AsyncIterable<Value, any, any>

Example​

console.log(
  await pipe(
    asAsync([asAsync([1, 2]), [3, `sloth`, 5], asAsync([6, 7])]),
    flattenAsync,
    reduceAsync(toArray()),
  ),
)
//=> [ 1, 2, 3, 'sloth', 5, 6, 7 ]

Defined in​

transforms.d.ts:235