Class AwaitableAsyncGenerator<T>

A class that wraps an AsyncGenerator and makes it both iterable and awaitable as a Promise. When used as a Promise, it will resolve to an array containing all generated values. When used as an AsyncGenerator, it behaves like the original generator.

Type Parameters

Hierarchy

AwaitableAsyncGenerator

Implements

AsyncGenerator<T>
Promise<T[]>

Index

Constructors

constructor

new AwaitableAsyncGenerator<T>(generator): AwaitableAsyncGenerator<T>
Type Parameters
- T
Parameters
- generator: AsyncGenerator<T, void, unknown>
Returns AwaitableAsyncGenerator<T>
- Defined in packages/util/src/async.ts:341
new AwaitableAsyncGenerator<T>(generator, thisArg?): AwaitableAsyncGenerator<T>
Type Parameters
- T
Parameters
- generator: (() => AsyncGenerator<T, void, unknown>)
  - - (): AsyncGenerator<T, void, unknown>
    - Returns AsyncGenerator<T, void, unknown>
- Optional thisArg: unknown
Returns AwaitableAsyncGenerator<T>
- Defined in packages/util/src/async.ts:342

Properties

`Readonly` [toStringTag]

[toStringTag]: "AwaitableAsyncGenerator" = 'AwaitableAsyncGenerator'

`Private` generator

generator: AsyncGenerator<T, void, unknown>

`Private` `Optional` promiseResult

promiseResult?: Promise<T[]>

Methods

[asyncIterator]

[asyncIterator](): AsyncGenerator<T, void, unknown>
Returns AsyncGenerator<T, void, unknown>
Implementation of AsyncGenerator.[asyncIterator]
- Defined in packages/util/src/async.ts:371

catch

catch<TResult>(onrejected?): Promise<T[] | TResult>
Type Parameters
- TResult = never
Parameters
- Optional onrejected: null | ((reason) => TResult | PromiseLike<TResult>)
Returns Promise<T[] | TResult>
Implementation of Promise.catch
- Defined in packages/util/src/async.ts:383

finally

finally(onfinally?): Promise<T[]>
Parameters
- Optional onfinally: null | (() => void)
Returns Promise<T[]>
Implementation of Promise.finally
- Defined in packages/util/src/async.ts:389

`Private` getGenerator

getGenerator(): AsyncGenerator<T, any, unknown>
Returns AsyncGenerator<T, any, unknown>
- Defined in packages/util/src/async.ts:351

`Private` getPromiseResult

getPromiseResult(): Promise<T[]>
Returns Promise<T[]>
- Defined in packages/util/src/async.ts:347

next(...__namedParameters): Promise<IteratorResult<T, void>>
Parameters
- Rest ...__namedParameters: [] | [unknown]
Returns Promise<IteratorResult<T, void>>
Implementation of AsyncGenerator.next
- Defined in packages/util/src/async.ts:359

return

return(value): Promise<IteratorResult<T, void>>
Parameters
- value: void | PromiseLike<void>
Returns Promise<IteratorResult<T, void>>
Implementation of AsyncGenerator.return
- Defined in packages/util/src/async.ts:363

then

then<TResult1, TResult2>(onfulfilled?, onrejected?): Promise<TResult1 | TResult2>
Type Parameters
- TResult1 = T[]
- TResult2 = never
Parameters
- Optional onfulfilled: null | ((value) => TResult1 | PromiseLike<TResult1>)
- Optional onrejected: null | ((reason) => TResult2 | PromiseLike<TResult2>)
Returns Promise<TResult1 | TResult2>
Implementation of Promise.then
- Defined in packages/util/src/async.ts:376

throw

throw(e): Promise<IteratorResult<T, void>>
Parameters
- e: any
Returns Promise<IteratorResult<T, void>>
Implementation of AsyncGenerator.throw
- Defined in packages/util/src/async.ts:367

Class AwaitableAsyncGenerator<T>

Type Parameters

T

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T

Parameters

generator: AsyncGenerator<T, void, unknown>

Returns AwaitableAsyncGenerator<T>

Type Parameters

T

Parameters

generator: (() => AsyncGenerator<T, void, unknown>)

Returns AsyncGenerator<T, void, unknown>

Optional thisArg: unknown

Returns AwaitableAsyncGenerator<T>

Properties

Readonly [toStringTag]

Private generator

Private Optional promiseResult

Methods

[asyncIterator]

Returns AsyncGenerator<T, void, unknown>

catch

Type Parameters

TResult = never

Parameters

Optional onrejected: null | ((reason) => TResult | PromiseLike<TResult>)

Returns Promise<T[] | TResult>

finally

Parameters

Optional onfinally: null | (() => void)

Returns Promise<T[]>

Private getGenerator

Returns AsyncGenerator<T, any, unknown>

Private getPromiseResult

Returns Promise<T[]>

next

Parameters

Rest ...__namedParameters: [] | [unknown]

Returns Promise<IteratorResult<T, void>>

return

Parameters

value: void | PromiseLike<void>

Returns Promise<IteratorResult<T, void>>

then

Type Parameters

TResult1 = T[]

TResult2 = never

Parameters

Optional onfulfilled: null | ((value) => TResult1 | PromiseLike<TResult1>)

Optional onrejected: null | ((reason) => TResult2 | PromiseLike<TResult2>)

Returns Promise<TResult1 | TResult2>

throw

Parameters

e: any

Returns Promise<IteratorResult<T, void>>

Settings

Member Visibility

Theme

On This Page

`Optional` thisArg: unknown

`Readonly` [toStringTag]

`Private` generator

`Private` `Optional` promiseResult

`Optional` onrejected: null | ((reason) => TResult | PromiseLike<TResult>)

`Optional` onfinally: null | (() => void)

`Private` getGenerator

`Private` getPromiseResult

`Rest` ...__namedParameters: [] | [unknown]

`Optional` onfulfilled: null | ((value) => TResult1 | PromiseLike<TResult1>)

`Optional` onrejected: null | ((reason) => TResult2 | PromiseLike<TResult2>)