Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

std/async/mod.ts>MuxAsyncIterator

Deno standard library
Go to Latest
The Standard Library has been moved to JSR. See the blog post for details.
class MuxAsyncIterator
implements AsyncIterable<T>
import { MuxAsyncIterator } from "https://deno.land/std@0.202.0/async/mod.ts";

The MuxAsyncIterator class multiplexes multiple async iterators into a single stream. It currently makes an assumption that the final result (the value returned and not yielded from the iterator) does not matter; if there is any result, it is discarded.

Examples

Example 1

import { MuxAsyncIterator } from "https://deno.land/std@0.202.0/async/mod.ts";

async function* gen123(): AsyncIterableIterator<number> {
  yield 1;
  yield 2;
  yield 3;
}

async function* gen456(): AsyncIterableIterator<number> {
  yield 4;
  yield 5;
  yield 6;
}

const mux = new MuxAsyncIterator<number>();
mux.add(gen123());
mux.add(gen456());
for await (const value of mux) {
  // ...
}
// ..

Methods

add(iterable: AsyncIterable<T>)
iterate(): AsyncIterableIterator<T>
[Symbol.asyncIterator](): AsyncIterator<T>