Skip to main content

Function: findAsync()

Returns an async iterable containing the first value of asyncIterable for which fn returns a value awaitable to a truthy value. Otherwise, returns an empty async iterable.

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

Example​

const asyncIterable = asAsync([1, 2, `sloth`, 4, `other string`])

console.log(
  await pipe(
    asyncIterable,
    findAsync(value => typeof value === `string`),
    orAsync(() => `yawn!`),
  )
)
//=> sloth

console.log(
  await pipe(
    asyncIterable,
    findAsync(value => Array.isArray(value)),
    orAsync(() => `yawn!`),
  )
)
//=> yawn!

findAsync(fn)​

findAsync<Value>(fn): (asyncIterable) => AsyncOptional<Value>

Returns an async iterable containing the first value of asyncIterable for which fn returns a value awaitable to a truthy value. Otherwise, returns an empty async iterable.

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

Type Parameters​

• Value

Parameters​

• fn

Returns​

Function

Parameters​

• asyncIterable: AsyncIterable<Value, any, any>

Returns​

AsyncOptional<Value>

Example​

const asyncIterable = asAsync([1, 2, `sloth`, 4, `other string`])

console.log(
  await pipe(
    asyncIterable,
    findAsync(value => typeof value === `string`),
    orAsync(() => `yawn!`),
  )
)
//=> sloth

console.log(
  await pipe(
    asyncIterable,
    findAsync(value => Array.isArray(value)),
    orAsync(() => `yawn!`),
  )
)
//=> yawn!

Defined in​

filters.d.ts:563

findAsync(fn, asyncIterable)​

findAsync<Value>(fn, asyncIterable): AsyncOptional<Value>

Returns an async iterable containing the first value of asyncIterable for which fn returns a value awaitable to a truthy value. Otherwise, returns an empty async iterable.

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

Type Parameters​

• Value

Parameters​

• fn

• asyncIterable: AsyncIterable<Value, any, any>

Returns​

AsyncOptional<Value>

Example​

const asyncIterable = asAsync([1, 2, `sloth`, 4, `other string`])

console.log(
  await pipe(
    asyncIterable,
    findAsync(value => typeof value === `string`),
    orAsync(() => `yawn!`),
  )
)
//=> sloth

console.log(
  await pipe(
    asyncIterable,
    findAsync(value => Array.isArray(value)),
    orAsync(() => `yawn!`),
  )
)
//=> yawn!

Defined in​

filters.d.ts:563