Class DisposableStack

constructor

• new DisposableStack(): DisposableStack

  Returns DisposableStack

Readonly[toStringTag]

disposed

• get disposed(): boolean

  Returns a value indicating whether this stack has been disposed.

  Returns boolean

[dispose]

• "[dispose]"(): void

  Returns void

adopt

• adopt<T>(value: T, onDispose: (value: T) => void): T

  Adds a value and associated disposal callback as a resource to the stack.

  Type Parameters

  • T

  Parameters

  • value: T

    The value to add.
  • onDispose: (value: T) => void

    The callback to use in place of a [Symbol.dispose]() method. Will be invoked with value as the first parameter.

  Returns T

  The provided value.

defer

• defer(onDispose: () => void): void

  Adds a callback to be invoked when the stack is disposed.

  Parameters

  • onDispose: () => void

  Returns void

dispose

• dispose(): void

  Disposes each resource in the stack in the reverse order that they were added.

  Returns void

move

• move(): DisposableStack

  Move all resources out of this stack and into a new DisposableStack, and marks this stack as disposed.

  Returns DisposableStack

  Example

  class C {
    #res1: Disposable;
    #res2: Disposable;
    #disposables: DisposableStack;
    constructor() {
      // stack will be disposed when exiting constructor for any reason
      using stack = new DisposableStack();
  
      // get first resource
      this.#res1 = stack.use(getResource1());
  
      // get second resource. If this fails, both `stack` and `#res1` will be disposed.
      this.#res2 = stack.use(getResource2());
  
      // all operations succeeded, move resources out of `stack` so that they aren't disposed
      // when constructor exits
      this.#disposables = stack.move();
    }
  
    [Symbol.dispose]() {
      this.#disposables.dispose();
    }
  }
  Copy

use

• use<T extends undefined | null | Disposable>(value: T): T

  Adds a disposable resource to the stack, returning the resource.

  Type Parameters

  • T extends undefined | null | Disposable

  Parameters

  • value: T

    The resource to add. null and undefined will not be added, but will be returned.

  Returns T

  The provided value.