Skip to main content
Home

Built and signed on GitHub Actions

Well-tested utility functions dealing with async iterables

This package works with Cloudflare Workers, Node.js, Deno, Bun, Browsers
This package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
This package works with Browsers
JSR Score
88%
Published
2 years ago (0.6.0)
function take
take<T>(
source: Iterable<T> | AsyncIterable<T>,
count: number,
): AsyncIterableIterator<T>

Takes a specified number of elements from the beginning of an async iterable.

import { take } from "./take.ts";
import { count } from "./infinite.ts";

const iterable = take(count(0, 5), 3);
for await (const value of iterable) {
  console.log(value);
}

The above example will print the following 3 lines:

0
5
10

If the iterable is shorter than the specified number, the whole elements are taken.

import { take } from "./take.ts";

async function* gen() { yield "foo"; yield "bar"; yield "baz"; }
const iterable = take(gen(), 5);
for await (const value of iterable) console.log(value);

The above example will print only 3 elements, because gen() yields only 3 elements:

foo
bar
baz

Type Parameters

The type of the elements in the source and the returned async iterable.

Parameters

source: Iterable<T> | AsyncIterable<T>

The async iterable to take elements from. It can be either finite or infinite.

count: number

The number of elements to take.

Return Type

AsyncIterableIterator<T>

An async iterable that yields the first count elements from the source iterable.

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@hongminhee/aitertools

Import symbol

import { take } from "@hongminhee/aitertools";
or

Import directly with a jsr specifier

import { take } from "jsr:@hongminhee/aitertools";

Add Package

pnpm i jsr:@hongminhee/aitertools
or (using pnpm 10.8 or older)
pnpm dlx jsr add @hongminhee/aitertools

Import symbol

import { take } from "@hongminhee/aitertools";

Add Package

yarn add jsr:@hongminhee/aitertools
or (using Yarn 4.8 or older)
yarn dlx jsr add @hongminhee/aitertools

Import symbol

import { take } from "@hongminhee/aitertools";

Add Package

vlt install jsr:@hongminhee/aitertools

Import symbol

import { take } from "@hongminhee/aitertools";

Add Package

npx jsr add @hongminhee/aitertools

Import symbol

import { take } from "@hongminhee/aitertools";

Add Package

bunx jsr add @hongminhee/aitertools

Import symbol

import { take } from "@hongminhee/aitertools";