DisposableStack.prototype[Symbol.dispose]()

The [Symbol.dispose]() method of DisposableStack instances implements the disposable protocol and allows it to be disposed when used with using or await using. It is an alias for the dispose() method.

Syntax

js
disposableStack[Symbol.dispose]()

Parameters

None.

Return value

None (undefined).

Examples

undefined

Declaring a stack with using

The Symbol.dispose method is intended to be automatically called in a using declaration.

js
{
  using disposer = new DisposableStack();
  const resource = disposer.use(new Resource());
  resource.doSomething();
  // stack is disposed here immediately before the function exits
  // which causes the resource to be disposed
}

Specifications

See also