FinalizationRegistry.prototype.register()

Метод register() экземпляров FinalizationRegistry регистрирует значение в этом FinalizationRegistry, чтобы, если значение будет собрано сборщиком мусора, мог быть вызван обратный вызов реестра.

Синтаксис

register(target, heldValue)
register(target, heldValue, unregisterToken)

Параметры

target

Целевое значение для регистрации.

heldValue

Значение, которое будет передано финализатору для этого target. Это не может быть само target, но может быть чем угодно другим, включая функции и примитивы.

unregisterToken Необязательно

Токен, который может быть использован с методом unregister позже для отмены регистрации целевого значения. Если предоставлен (и не undefined), это должен быть объект или незарегистрированный символ. Если не предоставлен, отмена регистрации цели невозможна.

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

Нет (undefined).

Исключения

TypeError

Выбрасывается в одном из следующих случаев:

• target не является объектом или незарегистрированным символом (объект в отличие от примитивов; функции также являются объектами)
• target совпадает с heldValue (target === heldValue)
• unregisterToken не является объектом или незарегистрированным символом

Описание

См. разделы Избегайте, когда это возможно и Примечания о обратных вызовах очистки на странице FinalizationRegistry для важных оговорок.

Примеры

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

Следующий пример регистрирует значение, на которое ссылается target, передавая удерживаемое значение "some value" и само целевое значение в качестве токена отмены регистрации:

registry.register(target, "some value", target);

Следующий пример регистрирует значение, на которое ссылается target, передавая другой объект в качестве удерживаемого значения и не передавая токен отмены регистрации (что означает, что target не может быть отменен):

registry.register(target, { useful: "info about target" });

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

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

См. также

• FinalizationRegistry