AsyncIterator

Объект AsyncIterator — это объект, соответствующий протоколу асинхронного итератора, предоставляя метод next(), который возвращает промис, разрешающийся в объект результата итератора. Объект AsyncIterator.prototype — это скрытый глобальный объект, от которого наследуются все встроенные асинхронные итераторы. Он предоставляет метод [Symbol.asyncIterator](), который возвращает сам объект асинхронного итератора, делая асинхронный итератор также асинхронно итерируемым.

Обратите внимание, что AsyncIterator не является глобальным объектом, хотя это будет так в будущем с предложением по вспомогательным функциям асинхронного итератора. Объект AsyncIterator.prototype, общий для всех встроенных асинхронных итераторов, можно получить с помощью следующего кода:

const AsyncIteratorPrototype = Object.getPrototypeOf(
  Object.getPrototypeOf(Object.getPrototypeOf((async function* () {})())),
);

Описание

В настоящее время единственным встроенным асинхронным итератором JavaScript является объект AsyncGenerator, возвращаемый асинхронными функциями-генераторами. Существуют и другие встроенные асинхронные итераторы в веб-API, например, итератор ReadableStream.

Каждый из этих асинхронных итераторов имеет отдельный объект-прототип, который определяет метод next(), используемый конкретным асинхронным итератором. Все эти объекты-прототипы наследуются от AsyncIterator.prototype, который предоставляет метод [Symbol.asyncIterator](), возвращающий сам объект асинхронного итератора, делая асинхронный итератор также асинхронно итерируемым.

Методы экземпляра

AsyncIterator.prototype[Symbol.asyncDispose]()

Вызывает и ожидает метод return() объекта this, если он существует. Это реализует протокол асинхронного освобождения ресурсов и позволяет освободить ресурс при использовании с await using.

AsyncIterator.prototype[Symbol.asyncIterator]()

Возвращает сам объект асинхронного итератора. Это позволяет объектам асинхронного итератора быть также асинхронно итерируемыми.

Примеры

Использование асинхронного итератора в качестве асинхронно итерируемого объекта

Все встроенные асинхронные итераторы также являются асинхронно итерируемыми, поэтому вы можете использовать их в цикле for await...of:

const asyncIterator = (async function* () {
  yield 1;
  yield 2;
  yield 3;
})();
(async () => {
  for await (const value of asyncIterator) {
    console.log(value);
  }
})();
// Logs: 1, 2, 3

Спецификации

Совместимость с браузерами

Смотрите также

• async function*
• Протоколы итерации