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

std/async/tee.ts>tee

Deno standard library
Go to Latest
The Standard Library has been moved to JSR. See the blog post for details.
function tee
import { tee } from "https://deno.land/std@0.220.0/async/tee.ts";

Branches the given async iterable into the n branches.

Examples

Example 1

import { tee } from "https://deno.land/std@0.220.0/async/tee.ts";

const gen = async function* gen() {
  yield 1;
  yield 2;
  yield 3;
};

const [branch1, branch2] = tee(gen());

for await (const n of branch1) {
  console.log(n); // => 1, 2, 3
}

for await (const n of branch2) {
  console.log(n); // => 1, 2, 3
}

Type Parameters

T
optional
N extends number = 2

Parameters

iterable: AsyncIterable<T>
optional
n: N = [UNSUPPORTED]

Returns

Tuple<AsyncIterable<T>, N>