DisposableStack.prototype.dispose()

The dispose() method of {{jsxref("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 ({{jsxref("undefined")}}).

Exceptions#

• {{jsxref("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 {{jsxref("SuppressedError")}} is created, with the original error as the suppressed property, and the new error as the error property.

Examples#

Disposing a stack#

Here we push three disposers to the stack, using the {{jsxref("DisposableStack/use", "use()")}}, {{jsxref("DisposableStack/adopt", "adopt()")}}, and {{jsxref("DisposableStack/defer", "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 {{jsxref("Statements/using", "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#

{{Specifications}}

Browser compatibility#

{{Compat}}

See also#

• JavaScript resource management
• {{jsxref("DisposableStack")}}
• {{jsxref("DisposableStack.prototype.adopt()")}}
• {{jsxref("DisposableStack.prototype.defer()")}}
• {{jsxref("DisposableStack.prototype.use()")}}
• DisposableStack.prototype[Symbol.dispose]()