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

Implements

AsyncGenerator<T>
Promise<T[]>

Index

Constructors

constructor

new AwaitableAsyncGenerator<T>(
generator: AsyncGenerator<T, void, unknown>,
): 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: () => AsyncGenerator<T, void, unknown>,
thisArg?: unknown,
): AwaitableAsyncGenerator<T>
Type Parameters
- T
Parameters
- generator: () => AsyncGenerator<T, void, unknown>
- OptionalthisArg: 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

[asyncDispose]

"[asyncDispose]"(): Promise<void>
Returns Promise<void>
Implementation of AsyncGenerator.[asyncDispose]
- Defined in packages/util/src/async.ts:379

[asyncIterator]

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

[dispose]

"[dispose]"(): void
Returns void
- Defined in packages/util/src/async.ts:375

catch

catch<TResult = never>(
onrejected?: null | ((reason: any) => TResult | PromiseLike<TResult>),
): Promise<T[] | TResult>
Attaches a callback for only the rejection of the Promise.
Type Parameters
- TResult = never
Parameters
- Optionalonrejected: null | ((reason: any) => TResult | PromiseLike<TResult>)
  The callback to execute when the Promise is rejected.
Returns Promise<T[] | TResult>
A Promise for the completion of the callback.
Implementation of Promise.catch
- Defined in packages/util/src/async.ts:391

finally

finally(onfinally?: null | (() => void)): Promise<T[]>
Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.
Parameters
- Optionalonfinally: null | (() => void)
  The callback to execute when the Promise is settled (fulfilled or rejected).
Returns Promise<T[]>
A Promise for the completion of the callback.
Implementation of Promise.finally
- Defined in packages/util/src/async.ts:397

`Private`getGenerator

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

return

return(value: void | PromiseLike<void>): 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 = T[], TResult2 = never>(
onfulfilled?: null | ((value: T[]) => TResult1 | PromiseLike<TResult1>),
onrejected?: null | ((reason: any) => TResult2 | PromiseLike<TResult2>),
): Promise<TResult1 | TResult2>
Attaches callbacks for the resolution and/or rejection of the Promise.
Type Parameters
- TResult1 = T[]
- TResult2 = never
Parameters
- Optionalonfulfilled: null | ((value: T[]) => TResult1 | PromiseLike<TResult1>)
  The callback to execute when the Promise is resolved.
- Optionalonrejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)
  The callback to execute when the Promise is rejected.
Returns Promise<TResult1 | TResult2>
A Promise for the completion of which ever callback is executed.
Implementation of Promise.then
- Defined in packages/util/src/async.ts:384

throw

throw(e: any): 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

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AwaitableAsyncGenerator<T>

Type Parameters

Parameters

Returns AwaitableAsyncGenerator<T>

Properties

Readonly[toStringTag]

Privategenerator

Private OptionalpromiseResult

Methods

[asyncDispose]

Returns Promise<void>

[asyncIterator]

Returns AsyncGenerator<T, void, unknown>

[dispose]

Returns void

catch

Type Parameters

Parameters

Returns Promise<T[] | TResult>

finally

Parameters

Returns Promise<T[]>

PrivategetGenerator

Returns AsyncGenerator<T>

PrivategetPromiseResult

Returns Promise<T[]>

next

Parameters

Returns Promise<IteratorResult<T, void>>

return

Parameters

Returns Promise<IteratorResult<T, void>>

then

Type Parameters

Parameters

Returns Promise<TResult1 | TResult2>

throw

Parameters

Returns Promise<IteratorResult<T, void>>

Settings

On This Page

`Readonly`[toStringTag]

`Private`generator

`Private` `Optional`promiseResult

`Private`getGenerator

`Private`getPromiseResult