Skip to main content
Home
Browse packagesDocsSign in

@hongminhee/aitertools@0.6.0
Built and signed on GitHub Actions

latest
dahlia/aitertools

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 takeWhile
takeWhile<T>(
source: Iterable<T> | AsyncIterable<T>,
predicate: (
value: T,
index: number,
) => boolean | Promise<boolean>,
): AsyncIterableIterator<T>

Takes elements from the beginning of an async iterable as long as a specified condition is met. If the condition is not met, the iterable stops.

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

const iterable = takeWhile(count(0), v => v < 4);
for await (const value of iterable) console.log(value);

The above example will print the following 4 lines:

0
1
2
3

An async predicate function also works. The following example will print the same 4 lines as the previous example:

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

const iterable = takeWhile(count(0), v => Promise.resolve(v < 4));
for await (const value of iterable) console.log(value);

A predicate function can take an index as well as the value.

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

const iterable = takeWhile(count(0, 10), (_, i) => i < 4);
for await (const value of iterable) console.log(value);

The above example will print the following 4 lines:

0
10
20
30

Type Parameters

T

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.

predicate: (
value: T,
index: number,
) => boolean | Promise<boolean>

A predicate function to test each source element for a condition; the second parameter of the function represents the index of the source element. It can be either synchronous or asynchronous.

Return Type

AsyncIterableIterator<T>

An async iterable that contains elements from the source iterable that occur before the element at which the predicate no longer passes.

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 { takeWhile } from "@hongminhee/aitertools/take";
or

Import directly with a jsr specifier

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

Add Package

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

Import symbol

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

Add Package

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

Import symbol

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

Add Package

vlt install jsr:@hongminhee/aitertools

Import symbol

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

Add Package

npx jsr add @hongminhee/aitertools

Import symbol

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

Add Package

bunx jsr add @hongminhee/aitertools

Import symbol

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