FinalizationRegistry.prototype.unregister()
Baseline
Widely available
*
This feature is well established and works across many devices and browser versions. It’s been available across browsers since April 2021.
* Some parts of this feature may have varying levels of support.
Phương thức unregister() của các instance FinalizationRegistry hủy đăng ký một giá trị target khỏi FinalizationRegistry này.
Cú pháp
unregister(unregisterToken)
Tham số
unregisterToken-
Token đã được dùng với phương thức
register()khi đăng ký giá trị target. Nhiều ô đăng ký cùngunregisterTokensẽ bị hủy đăng ký cùng nhau.
Giá trị trả về
Một giá trị boolean là true nếu ít nhất một ô đã bị hủy đăng ký và false nếu không có ô nào bị hủy đăng ký.
Ngoại lệ
TypeError-
Được ném ra nếu
unregisterTokenkhông phải là đối tượng hoặc symbol không đăng ký.
Mô tả
Khi một giá trị target đã được thu hồi, nó không còn được đăng ký trong registry nữa. Không cần gọi unregister trong cleanup callback của bạn. Chỉ gọi unregister nếu bạn chưa nhận được cleanup callback và không còn cần nhận nữa.
Ví dụ
Sử dụng unregister
Ví dụ này cho thấy việc đăng ký một đối tượng target dùng chính đối tượng đó làm unregister token, sau đó hủy đăng ký nó qua 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
}
}
Ví dụ này cho thấy việc đăng ký một đối tượng target dùng một đối tượng khác làm 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;
}
}
}
Đặc tả kỹ thuật
| Thông số kỹ thuật |
|---|
| ECMAScript® 2027 Language Specification # sec-finalization-registry.prototype.unregister |