Function takeWhile

takeWhile<V>(
input: V[],
predicate: (value: V, index: number) => Promise<boolean>,
): Promise<V[]>
Takes leading elements as long as predicate returns truthy, stopping at the first falsy result. Preserves the input container type.

Async predicate or AsyncIterable input wraps the result in a Promise (or AsyncIterable for AsyncIterable input).
Type Parameters
- V
Parameters
- input: V[]
- predicate: (value: V, index: number) => Promise<boolean>
Returns Promise<V[]>
Example
```
takeWhile([1, 2, 3, 1], v => v < 3)      // [1, 2]
takeWhile(new Set([1, 2, 3]), v => v < 3) // Set { 1, 2 }
```
- Defined in src/iterable.ts:1028
takeWhile<V>(input: V[], predicate: (value: V, index: number) => boolean): V[]
Takes leading elements as long as predicate returns truthy, stopping at the first falsy result. Preserves the input container type.

Async predicate or AsyncIterable input wraps the result in a Promise (or AsyncIterable for AsyncIterable input).
Type Parameters
- V
Parameters
- input: V[]
- predicate: (value: V, index: number) => boolean
Returns V[]
Example
```
takeWhile([1, 2, 3, 1], v => v < 3)      // [1, 2]
takeWhile(new Set([1, 2, 3]), v => v < 3) // Set { 1, 2 }
```
- Defined in src/iterable.ts:1032
takeWhile<K, V>(
input: Map<K, V>,
predicate: (value: [K, V], index: number) => boolean,
): Map<K, V>
Takes leading elements as long as predicate returns truthy, stopping at the first falsy result. Preserves the input container type.

Async predicate or AsyncIterable input wraps the result in a Promise (or AsyncIterable for AsyncIterable input).
Type Parameters
- K
- V
Parameters
- input: Map<K, V>
- predicate: (value: [K, V], index: number) => boolean
Returns Map<K, V>
Example
```
takeWhile([1, 2, 3, 1], v => v < 3)      // [1, 2]
takeWhile(new Set([1, 2, 3]), v => v < 3) // Set { 1, 2 }
```
- Defined in src/iterable.ts:1036
takeWhile<T>(
input: Set<T>,
predicate: (value: T, index: number) => boolean,
): Set<T>
Takes leading elements as long as predicate returns truthy, stopping at the first falsy result. Preserves the input container type.

Async predicate or AsyncIterable input wraps the result in a Promise (or AsyncIterable for AsyncIterable input).
Type Parameters
- T
Parameters
- input: Set<T>
- predicate: (value: T, index: number) => boolean
Returns Set<T>
Example
```
takeWhile([1, 2, 3, 1], v => v < 3)      // [1, 2]
takeWhile(new Set([1, 2, 3]), v => v < 3) // Set { 1, 2 }
```
- Defined in src/iterable.ts:1040
takeWhile<T>(
input: AsyncIterable<T>,
predicate: (value: T, index: number) => boolean | Promise<boolean>,
): AsyncIterable<T>
Takes leading elements as long as predicate returns truthy, stopping at the first falsy result. Preserves the input container type.

Async predicate or AsyncIterable input wraps the result in a Promise (or AsyncIterable for AsyncIterable input).
Type Parameters
- T
Parameters
- input: AsyncIterable<T>
- predicate: (value: T, index: number) => boolean | Promise<boolean>
Returns AsyncIterable<T>
Example
```
takeWhile([1, 2, 3, 1], v => v < 3)      // [1, 2]
takeWhile(new Set([1, 2, 3]), v => v < 3) // Set { 1, 2 }
```
- Defined in src/iterable.ts:1044
takeWhile<T>(
input: Iterable<T>,
predicate: (value: T, index: number) => boolean,
): Iterable<T>
Takes leading elements as long as predicate returns truthy, stopping at the first falsy result. Preserves the input container type.

Async predicate or AsyncIterable input wraps the result in a Promise (or AsyncIterable for AsyncIterable input).
Type Parameters
- T
Parameters
- input: Iterable<T>
- predicate: (value: T, index: number) => boolean
Returns Iterable<T>
Example
```
takeWhile([1, 2, 3, 1], v => v < 3)      // [1, 2]
takeWhile(new Set([1, 2, 3]), v => v < 3) // Set { 1, 2 }
```
- Defined in src/iterable.ts:1048
takeWhile<K extends PropertyKey, V>(
input: Record<K, V>,
predicate: (value: [K, V], index: number) => boolean,
): Partial<Record<K, V>>
Takes leading elements as long as predicate returns truthy, stopping at the first falsy result. Preserves the input container type.

Async predicate or AsyncIterable input wraps the result in a Promise (or AsyncIterable for AsyncIterable input).
Type Parameters
- K extends PropertyKey
- V
Parameters
- input: Record<K, V>
- predicate: (value: [K, V], index: number) => boolean
Returns Partial<Record<K, V>>
Example
```
takeWhile([1, 2, 3, 1], v => v < 3)      // [1, 2]
takeWhile(new Set([1, 2, 3]), v => v < 3) // Set { 1, 2 }
```
- Defined in src/iterable.ts:1052

Function takeWhile

Type Parameters

Parameters

Returns Promise<V[]>

Example

Type Parameters

Parameters

Returns V[]

Example

Type Parameters

Parameters

Returns Map<K, V>

Example

Type Parameters

Parameters

Returns Set<T>

Example

Type Parameters

Parameters

Returns AsyncIterable<T>

Example

Type Parameters

Parameters

Returns Iterable<T>

Example

Type Parameters

Parameters

Returns Partial<Record<K, V>>

Example

Settings