The AsyncGeneratorFunction()
constructor creates AsyncGeneratorFunction objects.
Note that AsyncGeneratorFunction
is not a global object. It could be obtained by evaluating the following code.
const AsyncGeneratorFunction = async function* () {}.constructor;
The AsyncGeneratorFunction()
constructor is not intended to be used directly, and all caveats mentioned in the Function() description apply to AsyncGeneratorFunction()
.
Syntax
new AsyncGeneratorFunction(functionBody)
new AsyncGeneratorFunction(arg1, functionBody)
new AsyncGeneratorFunction(arg1, arg2, functionBody)
new AsyncGeneratorFunction(arg1, arg2, /* …, */ argN, functionBody)
AsyncGeneratorFunction(functionBody)
AsyncGeneratorFunction(arg1, functionBody)
AsyncGeneratorFunction(arg1, arg2, functionBody)
AsyncGeneratorFunction(arg1, arg2, /* …, */ argN, functionBody)
Note:
AsyncGeneratorFunction()
can be called with or withoutnew
. Both create a newAsyncGeneratorFunction
instance.
Parameters
See Function().
Examples
Using the constructor
The following example uses the AsyncGeneratorFunction
constructor to create an async generator function.
const AsyncGeneratorFunction = async function* () {}.constructor;
const createAsyncGenerator = new AsyncGeneratorFunction("a", "yield a * 2");
const asyncGen = createAsyncGenerator(10);
asyncGen.next().then((res) => console.log(res.value)); // 20