async function*
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.
Khai báo async function* tạo ra một binding của một async generator function mới với tên đã cho.
Bạn cũng có thể định nghĩa async generator function bằng cách sử dụng async function* expression.
Try it
async function* foo() {
yield await Promise.resolve("a");
yield await Promise.resolve("b");
yield await Promise.resolve("c");
}
let str = "";
async function generate() {
for await (const val of foo()) {
str += val;
}
console.log(str);
}
generate();
// Expected output: "abc"
Cú pháp
async function* name(param0) {
statements
}
async function* name(param0, param1) {
statements
}
async function* name(param0, param1, /* …, */ paramN) {
statements
}
Note: Async generator function không có dạng arrow function tương ứng.
Note:
function và * là các token riêng biệt, vì vậy chúng có thể được phân cách bởi khoảng trắng hoặc ký tự kết thúc dòng. Tuy nhiên, không được có ký tự kết thúc dòng giữa async và function, nếu không dấu chấm phẩy sẽ được tự động chèn vào, khiến async trở thành một identifier và phần còn lại trở thành khai báo function*.
Tham số
name-
Tên của function.
paramOptional-
Tên của tham số chính thức cho function. Về cú pháp của tham số, xem tài liệu tham khảo Functions.
statementsOptional-
Các câu lệnh tạo nên phần thân của function.
Mô tả
Khai báo async function* tạo ra một đối tượng AsyncGeneratorFunction. Mỗi lần async generator function được gọi, nó trả về một đối tượng AsyncGenerator mới, tuân theo async iterator protocol. Mỗi lần gọi next() trả về một Promise giải quyết thành đối tượng kết quả iterator.
Async generator function kết hợp các tính năng của async function và generator function. Bạn có thể sử dụng cả từ khóa await và yield trong phần thân function. Điều này cho phép bạn xử lý các tác vụ bất đồng bộ một cách thuận tiện với await, trong khi tận dụng tính chất lazy của generator function.
Khi một promise được yield từ async generator, trạng thái cuối cùng của iterator result promise sẽ khớp với trạng thái của promise được yield. Ví dụ:
async function* foo() {
yield Promise.reject(new Error("failed"));
}
foo()
.next()
.catch((e) => console.error(e));
Error: failed sẽ được ghi ra, vì nếu promise được yield bị reject, kết quả iterator cũng sẽ bị reject. Thuộc tính value của kết quả đã resolved của async generator sẽ không phải là một promise khác.
Khai báo async function* hoạt động tương tự như khai báo function — chúng được hoisted lên đầu phạm vi của chúng và có thể được gọi ở bất kỳ đâu trong phạm vi đó, và chúng chỉ có thể được khai báo lại trong một số ngữ cảnh nhất định.
Ví dụ
Khai báo một async generator function
Async generator function luôn tạo ra các promise của kết quả — ngay cả khi mỗi bước yield là đồng bộ.
async function* myGenerator(step) {
await new Promise((resolve) => setTimeout(resolve, 10));
yield 0;
yield step;
yield step * 2;
}
const gen = myGenerator(2);
gen
.next()
.then((res) => {
console.log(res); // { value: 0, done: false }
return gen.next();
})
.then((res) => {
console.log(res); // { value: 2, done: false }
return gen.next();
})
.then((res) => {
console.log(res); // { value: 4, done: false }
return gen.next();
})
.then((res) => {
console.log(res); // { value: undefined, done: true }
return gen.next();
});
Sử dụng async generator function để đọc một loạt file
Trong ví dụ này, chúng ta đọc một loạt file và chỉ truy cập nội dung của chúng khi được yêu cầu, sử dụng module fs/promises của Node.
async function* readFiles(directory) {
const files = await fs.readdir(directory);
for (const file of files) {
const stats = await fs.stat(file);
if (stats.isFile()) {
yield {
name: file,
content: await fs.readFile(file, "utf8"),
};
}
}
}
const files = readFiles(".");
console.log((await files.next()).value);
// Possible output: { name: 'file1.txt', content: '...' }
console.log((await files.next()).value);
// Possible output: { name: 'file2.txt', content: '...' }
Đặc tả
| Specification |
|---|
| ECMAScript® 2027 Language Specification # sec-async-generator-function-definitions |