isSequence()function

isSequence(value: unknown): value is AsyncIterable<unknown>
ParamType
valueunknown
The value to test. required
Return
value is AsyncIterable<unknown>
true if value is an AsyncIterable, narrowing its type.

Is a value an async iterable object?

  • Any object with a Symbol.asyncIterator property is an async iterable.

Examples

isSequence((async function* () {})()) // true