The dispose() method of DisposableStack instances disposes this stack by calling all disposers registered to it in reverse order of registration. If the stack is already disposed, this method does nothing.
It performs the same action as using disposer = new DisposableStack() at scope exit. It can be used if you need to clean up at a point other than scope exit.
Syntax
dispose()
Parameters
None.
Return value
None (undefined).
Exceptions
- SuppressedError
- : Thrown if multiple disposers in the stack threw an error. If only one error is thrown, it is rethrown as-is. Otherwise, for each additional error, a new SuppressedError is created, with the original error as the
suppressedproperty, and the new error as theerrorproperty.
- : Thrown if multiple disposers in the stack threw an error. If only one error is thrown, it is rethrown as-is. Otherwise, for each additional error, a new SuppressedError is created, with the original error as the
Examples
Disposing a stack
Here we push three disposers to the stack, using the DisposableStack/use, DisposableStack/adopt, and DisposableStack/defer methods. When dispose() is called, the disposers are called in reverse order of registration.
Note that usually you don't need to call dispose() manually. Declare the stack with Statements/using, and its [Symbol.dispose]() method will be automatically called when the stack goes out of scope.
class Resource {
dispose() {
console.log("Resource disposed");
}
[Symbol.dispose]() {
console.log("Resource disposed via Symbol.dispose");
}
}
{
const disposer = new DisposableStack();
const resource = disposer.use(new Resource());
const resource2 = disposer.adopt(new Resource(), (resource) =>
resource.dispose(),
);
disposer.defer(() => console.log("Deferred disposer"));
disposer.dispose();
// Logs in order:
// Deferred disposer
// Resource disposed
// Resource disposed via Symbol.dispose
}
Specifications
Browser compatibility
See also
- Polyfill of
DisposableStack.prototype.disposeincore-js - JavaScript resource management
- DisposableStack
- DisposableStack.prototype.adopt()
- DisposableStack.prototype.defer()
- DisposableStack.prototype.use()
DisposableStack.prototype[Symbol.dispose]()
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
