AsyncDisposableStack.prototype.use()

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

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

Синтаксис

use(value)

Параметры

value

Значение для регистрации в стеке. Должно либо содержать метод [Symbol.asyncDispose]() или [Symbol.dispose](), либо быть null или undefined.

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

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

Исключения

TypeError

Выбрасывается, если value не является null или undefined, и не содержит метода [Symbol.asyncDispose]() или [Symbol.dispose]().

ReferenceError

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

Примеры

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

Эта функция считывает файл (как FileHandle Node.js) и возвращает его содержимое. Дескриптор файла автоматически закрывается, когда функция завершается, при условии, что класс FileHandle реализует метод [Symbol.asyncDispose](), который асинхронно закрывает файл.

async function readFileContents(path) {
  await using disposer = new AsyncDisposableStack();
  const handle = disposer.use(await fs.open(path));
  const data = await handle.read();
  return data;
  // The disposer is disposed here, which causes handle to be closed too
}

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

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

См. также

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