AsyncDisposableStack.prototype.adopt()

Метод adopt() экземпляров AsyncDisposableStack регистрирует значение, которое не реализует протокол асинхронного удаления, в стек, предоставляя пользовательскую функцию удаления.

См. DisposableStack.prototype.adopt() для получения общей информации о методе adopt().

Синтаксис

adopt(value, onDispose)

Параметры

value

Любое значение, которое нужно зарегистрировать в стеке.

onDispose

Функция, которая будет вызвана при удалении стека. Функция принимает value в качестве единственного аргумента и может вернуть промис, который будет ожидаться.

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

Тот же value, который был передан.

Исключения

TypeError

Выбрасывается, если onDispose не является функцией.

ReferenceError

Выбрасывается, если стек уже удален.

Примеры

Использование adopt()

Эта функция создает дескриптор файла (как Node.js FileHandle), который закрывается по завершении функции. Мы предполагаем, что дескриптор файла не реализует протокол асинхронного удаления (в действительности он реализует), поэтому мы используем adopt() для регистрации его в стеке. Поскольку метод handle.close() возвращает промис, нам нужно использовать AsyncDisposableStack, чтобы дождаться завершения удаления.

async function readFile(path) {
  await using disposer = new AsyncDisposableStack();
  const handle = disposer.adopt(
    await fs.open(path),
    async (handle) => await handle.close(),
  );
  const data = await handle.read();
  // The handle.close() method is called and awaited here before exiting
  return data;
}

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

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

См. также

• Управление ресурсами JavaScript
• AsyncDisposableStack
• AsyncDisposableStack.prototype.defer()
• AsyncDisposableStack.prototype.use()