Interface MaybeAsyncIterator<T, TReturn, TNext>

An Iterator that may be async.

interface MaybeAsyncIterator {
    next(...args): MaybePromise<IteratorResult<T, TReturn>>;
    return?(value?): MaybePromise<IteratorResult<T, TReturn>>;
    throw?(e?): MaybePromise<IteratorResult<T, TReturn>>;
}

Type Parameters

T
TReturn = any
TNext = unknown

Index

Methods

next return? throw?

Methods

next

next(...args): MaybePromise<IteratorResult<T, TReturn>>
Parameters
- Rest ...args: [] | [TNext]
Returns MaybePromise<IteratorResult<T, TReturn>>
- Defined in packages/commons/src/async/iterator.ts:6

`Optional` return

return(value?): MaybePromise<IteratorResult<T, TReturn>>
Parameters
- Optional value: MaybePromise<TReturn>
Returns MaybePromise<IteratorResult<T, TReturn>>
- Defined in packages/commons/src/async/iterator.ts:8

`Optional` throw

throw(e?): MaybePromise<IteratorResult<T, TReturn>>
Parameters
- Optional e: unknown
Returns MaybePromise<IteratorResult<T, TReturn>>
- Defined in packages/commons/src/async/iterator.ts:10

Generated using TypeDoc