大网数据广告活动
Web 标准与前端开发

DisposableStack

· 52CE 我爱测

The **`DisposableStack`** object represents a stack of disposers to run when the stack itself is disposed. Disposer functions are executed in reverse order of registration, with strong error handling guarantees. Calling its `move()` method will transfer responsibility for calling

The DisposableStack object represents a stack of disposers to run when the stack itself is disposed. Disposer functions are executed in reverse order of registration, with strong error handling guarantees. Calling its move() method will transfer responsibility for calling the current registered disposers to a new DisposableStack and prevent registering any additional disposers.

Description

A DisposableStack is not exactly a "stack" in terms of its interface. It has several methods for pushing disposers to it, but it has no way to pop one disposer off. Rather, all disposers are popped and executed one-by-one when the stack is disposed.

You register disposable resources to the DisposableStack using its DisposableStack/use, DisposableStack/adopt, or DisposableStack/defer methods.

using disposer = new DisposableStack();
const reader = disposer.use(stream.getReader());

Then, when the disposer goes out of scope, all resources registered to it are disposed in reverse order of registration, unless they have been moved out with move().

It is good practice to not extract the resource acquisition expression to a separate statement, no matter how long the expression is. You should always wrap the use() or adopt() call around the resource acquisition expression to ensure that the resource is registered to the stack immediately.

using disposer = new DisposableStack();
const reader = stream.getReader();
disposer.use(reader);

Functionally, these two code snippets are equivalent. However, the first one is less error-prone because the resource is declared and registered in a single line. If someone puts more code between the second and third lines of the second snippet, an error could occur, causing the resource to leak.

Constructor

  • DisposableStack/DisposableStack
    • : Creates a new DisposableStack object.

Instance properties

These properties are defined on DisposableStack.prototype and shared by all DisposableStack instances.

  • Object/constructor
    • : The constructor function that created the instance object. For DisposableStack instances, the initial value is the DisposableStack/DisposableStack constructor.
  • DisposableStack.prototype.disposed
    • : Read-only. Returns true if the DisposableStack has been disposed, or false if not.
  • DisposableStack.prototype[Symbol.toStringTag]
    • : The initial value of the [Symbol.toStringTag] property is the string "DisposableStack". This property is used in Object.prototype.toString().

Instance methods

  • DisposableStack.prototype.adopt()
    • : Registers a value that doesn't implement the disposable protocol to the stack by providing a custom disposer function.
  • DisposableStack.prototype.defer()
    • : Takes a callback function to be called when the stack is disposed.
  • DisposableStack.prototype.dispose()
    • : Disposes this stack by calling all disposers registered to it in reverse order of registration.
  • DisposableStack.prototype.move()
    • : Creates a new DisposableStack instance that contains the same disposers as this stack, and then marks this stack as disposed, without calling any disposers.
  • DisposableStack.prototype.use()
    • : Registers a value that implements the disposable protocol to the stack.
  • DisposableStack.prototype[Symbol.dispose]
    • : An alias for the dispose() method.

Specifications

Browser compatibility

See also

来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
MDN Web Docs / Mozilla 贡献者
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY-SA 2.5

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。