Skip to main content
Module

x/isx/top_types.ts>isAsyncIterable

TypeScript-first is function collections
Go to Latest
function isAsyncIterable
import { isAsyncIterable } from "https://deno.land/x/isx@1.0.0-beta.24/top_types.ts";

Whether the value is AsyncIterable or not.

Examples

Example 1

import { isAsyncIterable } from "https://deno.land/x/isx@$VERSION/mod.ts"
import { assertEquals } from "https://deno.land/std@$VERSION/testing/asserts.ts"
assertEquals(
  isAsyncIterable({
    async *[Symbol.asyncIterator]() {
      yield "hello";
    },
  }),
  true,
);
assertEquals(isAsyncIterable(() => {}), false);

Parameters

value: unknown
  • Any value.

Returns

value is AsyncIterable<T>