Is there destructor in TypeScript? If not, how can I delete an object?
I tried destructor() and ~ClassName() but it didn't work.
3 Answers
JavaScript uses garbage collection to automatically delete objects when they are no longer referenced. There is no concept of destructors or finalizers.
You can't observe when an object is deleted by the garbage collector, nor is it predictable.
9 Comments
obj.destruct() at the point just before the object's lifetime expires (e.g. when it leaves program scope).As of ES2021, finalizers were added to the specification.
To use that feature, you create a FinalizationRegistry, which notifies you when any of the associated objects get garbage collected.
You can use it like that:
const reg = new FinalizationRegistry((id: number) => {
console.log(`Test #${id} has been garbage collected`);
});
class Test{
id: number;
constructor(id: number){
this.id = id;
reg.register(this, this.id);
// ^^^^^^^--- This is the "testament", whatever value, which will be passed to the finalization callback
}
}
{
const test1 = new Test(1);
const test2 = new Test(2);
}
Note that when the callback is called, the object had already been garbage collected; only its "testament" (or as MDN puts it, less dramatically, the "held value") is given to the finalizer.
If you need access to some properties of the object in the finalizer, you can store them inside the testament, which, in this case, can (although not necessarily will) be garbage collected just after the original object:
interface TestTestament{
id: number,
intervalid: ReturnType<typeof setInterval>
}
const reg = new FinalizationRegistry((testament: TestTestament) => {
console.log(`Test #${testament.id} has been garbage collected`);
clearInterval(testament.intervalid);
});
class Test{
private testament: TestTestament;
constructor(id: number){
this.testament = {
id,
intervalid: setInterval(() => {
console.log(`Test interval #${id}`);
}, 1000)
};
reg.register(this, this.testament);
}
}
{
const test1 = new Test(1);
const test2 = new Test(2);
}
Note that the specification doesn't guarantee when garbage collection happens, so the finalizer may not even be called if the object stays in the memory.
2 Comments
You can actually
class MyClass {
constructor(input1, input2){
this.in1 = input1;
this.in2 = input2;
}
}
let myObject = {};
try {
myObject = {
classHandler: new MyClass('1','2')
}
} catch (e) {
} finally {
delete myObject.classHandler
// garbageCollect
if (global.gc) {global.gc()}
}
11 Comments
delete operator is that it just removes that reference to the object, and garbage collection still happens unpredictably as usual.delete, especially among newcomers to JavaScript, and I fear this answer perpetuates that. delete has nothing to do with garbage collection. In practice, it seems that the way to implement predictable resource clean-up is to add a method (e.g. destroy) then call it when the object is no longer needed by the app.delete. It means a method defined by a class that is automatically called when the object is garbage collected. Those using the language write the destructor themselves and usually use it to do clean up (close connection, remove temporary file or the like) that should happen when garbage collection happens.