CKTIS / JavaScript
Symbol.asyncIterator — протоколът за асинхронна итерация
Symbol.asyncIterator е вграден символ, който обозначава метода, предоставящ асинхронния итератор на даден обект. Така for await...of може да извлича последователни стойности, като изчаква резултатите от next().
Версия: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support
Синтаксис
Symbol.asyncIterator
object[Symbol.asyncIterator]()
async *[Symbol.asyncIterator]() { /* yield values */ }Symbol.asyncIterator е добре познат символ, използван като ключ на свойство, а не функция за директно извикване. Методът object[Symbol.asyncIterator]() връща асинхронен итератор — самия обект итератор, а не обещание за итератор. Този механизъм е част от ECMAScript от ECMAScript 2018 (ES2018); той не е Web API.
Асинхронно итерируемият обект предоставя този метод, а асинхронният итератор има метод next(), който връща обещание, изпълнявано с обект, представящ резултата. Ако свойството done липсва, резултатът се тълкува така, сякаш съдържа done: false. Резултат с done: true обозначава края на итерацията и може да не съдържа свойството value. Синтаксисът async *[Symbol.asyncIterator]() дефинира метод на асинхронен генератор, който обработва този протокол автоматично.
Цикълът for await...of първо търси Symbol.asyncIterator. Ако методът липсва или стойността му е null, цикълът използва Symbol.iterator и адаптира синхронния итератор. Обикновеният for...of не използва Symbol.asyncIterator. Не декларирайте фабриката за итератор като обикновен метод async: той би върнал обещание вместо итератор.
В примера всяко извикване на метода създава нов генератор, а цикълът събира стойностите последователно. Проверете поддръжката на синтаксиса и символа в целевата среда; нито самото наличие на Symbol.asyncIterator, нито използването на Node 24 в хранилището доказва съвместимост с браузъри.
Примери
const numbers = {
async *[Symbol.asyncIterator]() {
yield 1;
yield 2;
yield 3;
}
};
async function main() {
const values = [];
for await (const value of numbers) {
values.push(value);
}
console.log(values.join(', '));
}
main().catch(console.error);Резултат
1, 2, 3
Показаният код и заявеният резултат са проверени в изолирана среда по метода, записан в доказателството за проверка на тази точна версия.