Type Alias AsyncGenerator

AsyncGenerator: {
    __brand: "AsyncGenerator";
    constructor: AsyncGeneratorFunction;
    next: (value?: any) => Promise<IteratorResult<any>>;
    return?: (value?: any) => Promise<IteratorResult<any>>;
    throw?: (error?: any) => Promise<IteratorResult<any>>;
}

An async generator type created e.g. as:

/** @type {AsyncGenerator} */
const asyncGeneratorType = (async function* () {
  yield await Promise.resolve(1);
})();

@property {'AsyncGenerator'} [Symbol.toStringTag] Defines the Symbol.toStringTag property as "AsyncGenerator".

Type declaration

__brand: "AsyncGenerator"
constructor: AsyncGeneratorFunction
next: (value?: any) => Promise<IteratorResult<any>>
Optionalreturn?: (value?: any) => Promise<IteratorResult<any>>
Optionalthrow?: (error?: any) => Promise<IteratorResult<any>>

Type Alias AsyncGenerator

Type declaration

__brand: "AsyncGenerator"

constructor: AsyncGeneratorFunction

next: (value?: any) => Promise<IteratorResult<any>>

`Optional`return?: (value?: any) => Promise<IteratorResult<any>>

`Optional`throw?: (error?: any) => Promise<IteratorResult<any>>

Settings

Type Alias AsyncGenerator

Type declaration

__brand: "AsyncGenerator"

constructor: AsyncGeneratorFunction

next: (value?: any) => Promise<IteratorResult<any>>

Optionalreturn?: (value?: any) => Promise<IteratorResult<any>>

Optionalthrow?: (error?: any) => Promise<IteratorResult<any>>

Settings

`Optional`return?: (value?: any) => Promise<IteratorResult<any>>

`Optional`throw?: (error?: any) => Promise<IteratorResult<any>>