Symbol.asyncIterator

Статическое свойство данных Symbol.asyncIterator представляет собой хорошо известный символ Symbol.asyncIterator. Протокол асинхронной итерации ищет этот символ для метода, который возвращает асинхронный итератор для объекта. Для того чтобы объект был асинхронно итерируемым, он должен иметь ключ [Symbol.asyncIterator].

Попробуйте

const delayedResponses = {
  delays: [500, 1300, 3500],

  wait(delay) {
    return new Promise((resolve) => {
      setTimeout(resolve, delay);
    });
  },

  async *[Symbol.asyncIterator]() {
    for (const delay of this.delays) {
      await this.wait(delay);
      yield `Delayed response for ${delay} milliseconds`;
    }
  },
};

(async () => {
  for await (const response of delayedResponses) {
    console.log(response);
  }
})();

// Expected output: "Delayed response for 500 milliseconds"
// Expected output: "Delayed response for 1300 milliseconds"
// Expected output: "Delayed response for 3500 milliseconds"

Значение

Хорошо известный символ Symbol.asyncIterator.

Примеры

Пользовательские асинхронные итераторы

Вы можете определить свой собственный асинхронный итератор, установив свойство [Symbol.asyncIterator]() для объекта.

const myAsyncIterable = {
  async *[Symbol.asyncIterator]() {
    yield "hello";
    yield "async";
    yield "iteration!";
  },
};

(async () => {
  for await (const x of myAsyncIterable) {
    console.log(x);
  }
})();
// Logs:
// "hello"
// "async"
// "iteration!"

При создании API помните, что асинхронные итераторы предназначены для представления чего-то *итерируемого*, например, потока данных или списка, а не для полной замены колбэков и событий в большинстве ситуаций.

Встроенные асинхронные итераторы

В базовом языке JavaScript нет объекта, который был бы асинхронно итерируемым. Некоторые веб-API, такие как ReadableStream, по умолчанию имеют метод Symbol.asyncIterator.

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

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

См. также

• Протоколы итерации
• for await...of