Skip to main content

Variable: filterAsync()

const filterAsync: {<From, To>(fn): (asyncIterable) => AsyncIterable<To>; <From, To>(fn, asyncIterable): AsyncIterable<To>; <Value>(fn): (asyncIterable) => AsyncIterable<Value>; <Value>(fn, asyncIterable): AsyncIterable<Value>; }

Defined in: filters.d.ts:76

Returns an async iterable that contains the values of asyncIterable in iteration order excluding the values for which fn returns a value awaitable to a falsy value.

Like Array.prototype.filter, but for async iterables.

Call Signature​

<From, To>(fn): (asyncIterable) => AsyncIterable<To>

Type Parameters​

From​

From

To​

To

Parameters​

fn​

(value) => value is To

Returns​

(asyncIterable): AsyncIterable<To>

Parameters​

asyncIterable​

AsyncIterable<From>

Returns​

AsyncIterable<To>

Call Signature​

<From, To>(fn, asyncIterable): AsyncIterable<To>

Type Parameters​

From​

From

To​

To

Parameters​

fn​

(value) => value is To

asyncIterable​

AsyncIterable<From>

Returns​

AsyncIterable<To>

Call Signature​

<Value>(fn): (asyncIterable) => AsyncIterable<Value>

Type Parameters​

Value​

Value

Parameters​

fn​

(value) => unknown

Returns​

(asyncIterable): AsyncIterable<Value>

Parameters​

asyncIterable​

AsyncIterable<Value>

Returns​

AsyncIterable<Value>

Call Signature​

<Value>(fn, asyncIterable): AsyncIterable<Value>

Type Parameters​

Value​

Value

Parameters​

fn​

(value) => unknown

asyncIterable​

AsyncIterable<Value>

Returns​

AsyncIterable<Value>

Example​

import { asAsync, filterAsync, pipe, reduceAsync, toArray } from 'lfi'

const API_URL = `https://api.dictionaryapi.dev/api/v2/entries/en`

console.log(
  await pipe(
    asAsync([`sloth`, `lazy`, `sleep`]),
    filterAsync(async word => {
      const response = await fetch(`${API_URL}/${word}`)
      const [{ meanings }] = await response.json()
      return meanings.some(meaning => meaning.partOfSpeech === `adjective`)
    }),
    reduceAsync(toArray()),
  ),
)
//=> [ 'lazy' ]
Playground

Since​

v0.0.1