Function filter

filter<V>(
input: V[],
predicate: (value: V, index: number) => Promise<boolean>,
): Promise<V[]>
Filters an iterable structure preserving the original container type.

When the predicate returns a Promise, the function returns a Promise of the resulting container.
Type Parameters
- V
Parameters
- input: V[]
- predicate: (value: V, index: number) => Promise<boolean>
Returns Promise<V[]>
Example
```
filter([1, 2, 3, 4], v => v % 2 === 0)            // [2, 4]
await filter([1, 2, 3], async v => v > 1)          // [2, 3]
```
- Defined in src/iterable.ts:459
filter<V, R>(
input: V[],
predicate: (value: V, index: number) => value is R,
): R[]
Filters an iterable structure preserving the original container type.

When the predicate returns a Promise, the function returns a Promise of the resulting container.
Type Parameters
- V
- R
Parameters
- input: V[]
- predicate: (value: V, index: number) => value is R
Returns R[]
Example
```
filter([1, 2, 3, 4], v => v % 2 === 0)            // [2, 4]
await filter([1, 2, 3], async v => v > 1)          // [2, 3]
```
- Defined in src/iterable.ts:463
filter<V>(input: V[], predicate: (value: V, index: number) => boolean): V[]
Filters an iterable structure preserving the original container type.

When the predicate returns a Promise, the function returns a Promise of the resulting container.
Type Parameters
- V
Parameters
- input: V[]
- predicate: (value: V, index: number) => boolean
Returns V[]
Example
```
filter([1, 2, 3, 4], v => v % 2 === 0)            // [2, 4]
await filter([1, 2, 3], async v => v > 1)          // [2, 3]
```
- Defined in src/iterable.ts:467
filter<K, V>(
input: Map<K, V>,
predicate: (value: [K, V], index: number) => Promise<boolean>,
): Promise<Map<K, V>>
Filters an iterable structure preserving the original container type.

When the predicate returns a Promise, the function returns a Promise of the resulting container.
Type Parameters
- K
- V
Parameters
- input: Map<K, V>
- predicate: (value: [K, V], index: number) => Promise<boolean>
Returns Promise<Map<K, V>>
Example
```
filter([1, 2, 3, 4], v => v % 2 === 0)            // [2, 4]
await filter([1, 2, 3], async v => v > 1)          // [2, 3]
```
- Defined in src/iterable.ts:471
filter<K, V>(
input: Map<K, V>,
predicate: (value: [K, V], index: number) => boolean,
): Map<K, V>
Filters an iterable structure preserving the original container type.

When the predicate returns a Promise, the function returns a Promise of the resulting container.
Type Parameters
- K
- V
Parameters
- input: Map<K, V>
- predicate: (value: [K, V], index: number) => boolean
Returns Map<K, V>
Example
```
filter([1, 2, 3, 4], v => v % 2 === 0)            // [2, 4]
await filter([1, 2, 3], async v => v > 1)          // [2, 3]
```
- Defined in src/iterable.ts:475
filter<T>(
input: Set<T>,
predicate: (value: T, index: number) => Promise<boolean>,
): Promise<Set<T>>
Filters an iterable structure preserving the original container type.

When the predicate returns a Promise, the function returns a Promise of the resulting container.
Type Parameters
- T
Parameters
- input: Set<T>
- predicate: (value: T, index: number) => Promise<boolean>
Returns Promise<Set<T>>
Example
```
filter([1, 2, 3, 4], v => v % 2 === 0)            // [2, 4]
await filter([1, 2, 3], async v => v > 1)          // [2, 3]
```
- Defined in src/iterable.ts:479
filter<T, R>(
input: Set<T>,
predicate: (value: T, index: number) => value is R,
): Set<R>
Filters an iterable structure preserving the original container type.

When the predicate returns a Promise, the function returns a Promise of the resulting container.
Type Parameters
- T
- R
Parameters
- input: Set<T>
- predicate: (value: T, index: number) => value is R
Returns Set<R>
Example
```
filter([1, 2, 3, 4], v => v % 2 === 0)            // [2, 4]
await filter([1, 2, 3], async v => v > 1)          // [2, 3]
```
- Defined in src/iterable.ts:483
filter<T>(
input: Set<T>,
predicate: (value: T, index: number) => boolean,
): Set<T>
Filters an iterable structure preserving the original container type.

When the predicate returns a Promise, the function returns a Promise of the resulting container.
Type Parameters
- T
Parameters
- input: Set<T>
- predicate: (value: T, index: number) => boolean
Returns Set<T>
Example
```
filter([1, 2, 3, 4], v => v % 2 === 0)            // [2, 4]
await filter([1, 2, 3], async v => v > 1)          // [2, 3]
```
- Defined in src/iterable.ts:487
filter<T>(
input: AsyncIterable<T>,
predicate: (value: T, index: number) => boolean | Promise<boolean>,
): AsyncIterable<T>
Filters an iterable structure preserving the original container type.

When the predicate returns a Promise, the function returns a Promise of the resulting container.
Type Parameters
- T
Parameters
- input: AsyncIterable<T>
- predicate: (value: T, index: number) => boolean | Promise<boolean>
Returns AsyncIterable<T>
Example
```
filter([1, 2, 3, 4], v => v % 2 === 0)            // [2, 4]
await filter([1, 2, 3], async v => v > 1)          // [2, 3]
```
- Defined in src/iterable.ts:491
filter<T>(
input: Iterable<T>,
predicate: (value: T, index: number) => Promise<boolean>,
): Promise<Iterable<T, any, any>>
Filters an iterable structure preserving the original container type.

When the predicate returns a Promise, the function returns a Promise of the resulting container.
Type Parameters
- T
Parameters
- input: Iterable<T>
- predicate: (value: T, index: number) => Promise<boolean>
Returns Promise<Iterable<T, any, any>>
Example
```
filter([1, 2, 3, 4], v => v % 2 === 0)            // [2, 4]
await filter([1, 2, 3], async v => v > 1)          // [2, 3]
```
- Defined in src/iterable.ts:495
filter<T>(
input: Iterable<T>,
predicate: (value: T, index: number) => boolean,
): Iterable<T>
Filters an iterable structure preserving the original container type.

When the predicate returns a Promise, the function returns a Promise of the resulting container.
Type Parameters
- T
Parameters
- input: Iterable<T>
- predicate: (value: T, index: number) => boolean
Returns Iterable<T>
Example
```
filter([1, 2, 3, 4], v => v % 2 === 0)            // [2, 4]
await filter([1, 2, 3], async v => v > 1)          // [2, 3]
```
- Defined in src/iterable.ts:499
filter<K extends PropertyKey, V>(
input: Record<K, V>,
predicate: (value: [K, V], index: number) => Promise<boolean>,
): Promise<Record<K, V>>
Filters an iterable structure preserving the original container type.

When the predicate returns a Promise, the function returns a Promise of the resulting container.
Type Parameters
- K extends PropertyKey
- V
Parameters
- input: Record<K, V>
- predicate: (value: [K, V], index: number) => Promise<boolean>
Returns Promise<Record<K, V>>
Example
```
filter([1, 2, 3, 4], v => v % 2 === 0)            // [2, 4]
await filter([1, 2, 3], async v => v > 1)          // [2, 3]
```
- Defined in src/iterable.ts:503
filter<K extends PropertyKey, V>(
input: Record<K, V>,
predicate: (value: [K, V], index: number) => boolean,
): Record<K, V>
Filters an iterable structure preserving the original container type.

When the predicate returns a Promise, the function returns a Promise of the resulting container.
Type Parameters
- K extends PropertyKey
- V
Parameters
- input: Record<K, V>
- predicate: (value: [K, V], index: number) => boolean
Returns Record<K, V>
Example
```
filter([1, 2, 3, 4], v => v % 2 === 0)            // [2, 4]
await filter([1, 2, 3], async v => v > 1)          // [2, 3]
```
- Defined in src/iterable.ts:507

Function filter

Type Parameters

Parameters

Returns Promise<V[]>

Example

Type Parameters

Parameters

Returns R[]

Example

Type Parameters

Parameters

Returns V[]

Example

Type Parameters

Parameters

Returns Promise<Map<K, V>>

Example

Type Parameters

Parameters

Returns Map<K, V>

Example

Type Parameters

Parameters

Returns Promise<Set<T>>

Example

Type Parameters

Parameters

Returns Set<R>

Example

Type Parameters

Parameters

Returns Set<T>

Example

Type Parameters

Parameters

Returns AsyncIterable<T>

Example

Type Parameters

Parameters

Returns Promise<Iterable<T, any, any>>

Example

Type Parameters

Parameters

Returns Iterable<T>

Example

Type Parameters

Parameters

Returns Promise<Record<K, V>>

Example

Type Parameters

Parameters

Returns Record<K, V>

Example

Settings