DisposableStack.prototype.adopt()

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

Синтаксис

adopt(value, onDispose)

Параметры

value

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

onDispose

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

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

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

Исключения

TypeError

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

ReferenceError

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

Описание

Основная цель adopt() — зарегистрировать значение, которое не реализует протокол disposable, в стеке. Если значение уже disposable, вы можете использовать use() вместо этого, который автоматически использует метод [Symbol.dispose]() значения в качестве очистки.

adopt(value, onDispose) почти так же, как defer(() => onDispose(value)), но он позволяет объявить ресурс и зарегистрировать его в одной строке. Таким образом, существует минимальная вероятность ошибки между созданием ресурса и его регистрацией, которая приведет к утечке ресурса.

using disposer = new DisposableStack();
const reader = disposer.adopt(stream.getReader(), (reader) =>
  reader.releaseLock(),
);

using disposer = new DisposableStack();
const reader = stream.getReader();
// If someone adds code in between these lines and an error occurs,
// the stream will be locked forever.
disposer.defer(() => reader.close());

В том же духе "сделайте ваш ресурс зарегистрированным, как только он будет объявлен", вы всегда должны заключать выражение получения ресурса в adopt(), вместо того чтобы извлекать его в отдельное выражение.

using disposer = new DisposableStack();
const reader = stream.getReader();
disposer.adopt(reader, (reader) => reader.close());

Примеры

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

Этот код потребляет ReadableStream через ReadableStreamDefaultReader. Читатель не реализует протокол disposable, поэтому мы используем adopt() для его регистрации в стеке.

{
  using disposer = new DisposableStack();
  const reader = disposer.adopt(stream.getReader(), (reader) =>
    reader.releaseLock(),
  );
  const { value, done } = reader.read();
  if (!done) {
    // Process the value
  }
  // The reader.releaseLock() method is called here before exiting
}

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

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

См. также

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