Symbol.dispose

Статическое свойство данных Symbol.dispose представляет собой общеизвестный символ Symbol.dispose. Объявление using ищет этот символ в инициализаторе переменной для метода, который будет вызван, когда переменная выйдет из области видимости.

Значение

Общеизвестный символ Symbol.dispose.

Описание

Объект является освобождаемым (disposable), если у него есть метод [Symbol.dispose](). Ожидается, что метод будет иметь следующую семантику:

• Вызов этого метода уведомляет объект Disposable о том, что вызывающая сторона не намерена продолжать использовать этот объект. Этот метод должен выполнять всю необходимую логику для явного освобождения ресурса, включая, но не ограничиваясь, файловые дескрипторы, потоки, объектные ссылки среды выполнения и т. д.
• Когда из этого метода выбрасывается исключение, это обычно означает, что ресурс не удалось явно освободить.
• При вызове более одного раза для одного и того же объекта функция не должна вызывать исключение. Однако это требование не применяется.

Этот метод не должен возвращать промис, так как промисы, возвращаемые [Symbol.dispose](), не ожидаются await using. Для объявления асинхронных освобождаемых объектов используйте Symbol.asyncDispose.

Примеры

Пользовательские освобождаемые объекты

[Symbol.dispose] позволяет создавать пользовательские освобождаемые объекты. См. using для получения дополнительной информации.

class Disposable {
  constructor() {
    this.disposed = false;
  }

  [Symbol.dispose]() {
    this.disposed = true;
  }

  get isDisposed() {
    return this.disposed;
  }
}

const resource = new Disposable();
{
  using resourceUsed = resource;
  console.log(resource.isDisposed); // false
}
console.log(resource.isDisposed); // true

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

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

См. также

• Polyfill Symbol.dispose в core-js
• Управление ресурсами в JavaScript
• Symbol.asyncDispose
• using
• DisposableStack.prototype[Symbol.dispose]()
• Iterator.prototype[Symbol.dispose]()