FinalizationRegistry.prototype.unregister()

Метод unregister() экземпляров FinalizationRegistry отменяет регистрацию целевого значения из этого FinalizationRegistry.

Синтаксис

unregister(unregisterToken)

Параметры

unregisterToken

Токен, использованный с методом register() при регистрации целевого значения. Несколько ячеек, зарегистрированных с одним и тем же unregisterToken, будут отменены вместе.

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

Логическое значение, которое является true, если была отменена регистрация как минимум одной ячейки, и false, если не была отменена регистрация ни одной ячейки.

Исключения

TypeError

Выбрасывается, если unregisterToken не является объектом или незарегистрированным символом.

Описание

Когда целевое значение было освобождено, оно больше не зарегистрировано в реестре. Нет необходимости вызывать unregister в вашем обработчике очистки. Вызывайте unregister только в том случае, если вы не получили обработчик очистки и больше не нуждаетесь в его получении.

Примеры

Использование unregister

Этот пример показывает регистрацию целевого объекта с использованием того же объекта в качестве токена отмены регистрации, а затем его последующую отмену регистрации через unregister:

class Thingy {
  static #cleanup = (label) => {
    //               ^^^^^−−−−− held value
    console.error(
      `The "release" method was never called for the object with the label "${label}"`,
    );
  };
  #registry = new FinalizationRegistry(Thingy.#cleanup);

  /**
   * Constructs a `Thingy` instance.
   * Be sure to call `release` when you're done with it.
   *
   * @param label A label for the `Thingy`.
   */
  constructor(label) {
    //                            vvvvv−−−−− held value
    this.#registry.register(this, label, this);
    //          target −−−−−^^^^         ^^^^−−−−− unregister token
  }

  /**
   * Releases resources held by this `Thingy` instance.
   */
  release() {
    this.#registry.unregister(this);
    //                        ^^^^−−−−− unregister token
  }
}

Этот пример показывает регистрацию целевого объекта с использованием другого объекта в качестве его токена отмены регистрации:

class Thingy {
  static #cleanup = (file) => {
    //               ^^^^−−−−− held value
    console.error(
      `The "release" method was never called for the "Thingy" for the file "${file.name}"`,
    );
  };
  #registry = new FinalizationRegistry(Thingy.#cleanup);
  #file;

  /**
   * Constructs a `Thingy` instance for the given file.
   * Be sure to call `release` when you're done with it.
   *
   * @param filename The name of the file.
   */
  constructor(filename) {
    this.#file = File.open(filename);
    //                            vvvvv−−−−− held value
    this.#registry.register(this, label, this.#file);
    //          target −−−−−^^^^         ^^^^^^^^^^−−−−− unregister token
  }

  /**
   * Releases resources held by this `Thingy` instance.
   */
  release() {
    if (this.#file) {
      this.#registry.unregister(this.#file);
      //                        ^^^^^^^^^^−−−−− unregister token
      File.close(this.#file);
      this.#file = null;
    }
  }
}

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

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

См. также

• FinalizationRegistry