@monstermann/fn/dist/function/isAsyncIterable.d.ts

A utility library for TypeScript.

//#region src/function/isAsyncIterable.d.ts
/**
 * `isAsyncIterable(value)`
 *
 * Checks if a value is an async iterable by testing for the presence of `Symbol.asyncIterator`.
 *
 * ```ts
 * isAsyncIterable(
 *     (async function* () {
 *         yield 1;
 *     })(),
 * ); // true
 *
 * isAsyncIterable([1, 2, 3]); // false
 * ```
 *
 * ```ts
 * pipe(
 *     (async function* () {
 *         yield 1;
 *     })(),
 *     isAsyncIterable(),
 * ); // true
 *
 * pipe([1, 2, 3], isAsyncIterable()); // false
 * ```
 */
declare const isAsyncIterable: {
  (): (value: unknown) => value is AsyncIterable<unknown>;
  (value: unknown): value is AsyncIterable<unknown>;
};
//#endregion
export { isAsyncIterable };