Function hasAsyncIteratorSymbol

  • Check if given object has the Symbol.asyncIterator symbol.

    Example

    hasAsyncIteratorSymbol({ [Symbol.asyncIterator]() {} }); // true
    hasAsyncIteratorSymbol({ bar: "bar" }); // false

    Returns

    true when given object has the Symbol.asyncIterator symbol, false otherwise.

    Type Parameters

    • Actual extends object

    Parameters

    • object: Actual | Readonly<Record<typeof asyncIterator, unknown>>

    Returns object is Readonly<Record<typeof asyncIterator, unknown>>