FinalizationRegistry.prototype.register()

¥Syntax

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

¥Parameters

target

要注册的目标值。

heldValue

要传递给此 target 的终结器的值。这不能是 target 本身，而可以是其他任何东西，包括函数和原语。

unregisterToken Optional

稍后可以与 unregister 方法一起使用的令牌，用于取消注册目标值。如果提供（而不是 undefined），则它必须是一个对象或 未注册符号。如果未提供，则无法取消注册目标。

¥Return value

无 (undefined)。

¥None (undefined).

¥Exceptions

TypeError

有下列情况之一的，抛出：

• target 不是对象或 未注册符号（对象与基元相反；函数也是对象）
• target 与 heldvalue (target === heldValue) 相同
• unregisterToken 不是对象或 未注册符号

¥Description

请参阅 FinalizationRegistry 页的 尽可能避免 和 关于清理回调的注意事项 部分了解重要注意事项。

¥See the Avoid where possible and Notes on cleanup callbacks sections of the FinalizationRegistry page for important caveats.

¥Examples

¥Using register

以下注册了 target 引用的值，传入保存的值 "some value" 并将目标本身作为取消注册令牌传递：

¥The following registers the value referenced by target, passing in the held value "some value" and passing the target itself as the unregistration token:

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

下面注册了 target 引用的值，传入另一个对象作为持有值，并且不传入任何注销令牌（这意味着 target 无法注销）：

¥The following registers the value referenced by target, passing in another object as the held value, and not passing in any unregistration token (which means target can't be unregistered):

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

¥See also

• FinalizationRegistry