isAsyncIterable

Determine if a value is an async iterable

Usage

Returns a boolean if the given value is an object with a [Symbol.asyncIterator] method.

import { 
function isAsyncIterable(value: unknown): value is AsyncIterable
Checks if a value is an async iterable.
@see ― https://radashi.js.org/reference/typed/isAsyncIterable
@example 
isAsyncIterable((async function* () { yield 1 })())
// => true

isAsyncIterable([1, 2, 3])
// => false
@version ― 12.4.0
isAsyncIterable } from 'radashi'

function isAsyncIterable(value: unknown): value is AsyncIterable
Checks if a value is an async iterable.
@see ― https://radashi.js.org/reference/typed/isAsyncIterable
@example 
isAsyncIterable((async function* () { yield 1 })())
// => true

isAsyncIterable([1, 2, 3])
// => false
@version ― 12.4.0
isAsyncIterable(
  (async function* () {
    yield 1
  })(),
)
// => true

function isAsyncIterable(value: unknown): value is AsyncIterable
Checks if a value is an async iterable.
@see ― https://radashi.js.org/reference/typed/isAsyncIterable
@example 
isAsyncIterable((async function* () { yield 1 })())
// => true

isAsyncIterable([1, 2, 3])
// => false
@version ― 12.4.0
isAsyncIterable([1, 2, 3])
// => false

If used in an environment where Symbol.asyncIterator is not available, the function will use Symbol.for('Symbol.asyncIterator') as a fallback.