AsyncIterator.prototype[Symbol.asyncDispose]()

Метод [Symbol.asyncDispose]() экземпляров AsyncIterator реализует протокол асинхронного управления ресурсами и позволяет освобождать ресурс при использовании с await using. Он вызывает и ожидает метод return() this, если он существует.

Синтаксис

asyncIterator[Symbol.asyncDispose]()

Параметры

Нет.

Возвращаемое значение

Нет (undefined).

Примеры

Объявление асинхронного итератора с помощью await using

Метод Symbol.asyncDispose предназначен для автоматического вызова в объявлении await using. Это полезно, если у вас есть асинхронный итератор, который вы вручную перебираете, вызывая его метод next(); если вы перебираете его с помощью for await...of или аналогичного, то обработка ошибок и очистка выполняются автоматически.

async function* generateNumbers() {
  try {
    yield 1;
    yield 2;
    yield 3;
  } finally {
    console.log("Cleaning up");
  }
}

async function doSomething() {
  await using numbers = generateNumbers();
  const res1 = await numbers.next();
  // Not iterating the rest of the numbers
  // Before the function exits, the async iterator is disposed
  // Logs "Cleaning up"
}

doSomething();

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

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

См. также

• Polyfill для AsyncIterator.prototype[Symbol.asyncDispose] в core-js
• Управление ресурсами в JavaScript
• Symbol.asyncDispose
• await using