AsyncDisposableStack.prototype[Symbol.asyncDispose]()

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

Syntax

js
asyncDisposableStack[Symbol.asyncDispose]()

Parameters

None.

Return value

None (undefined).

Examples

undefined

Declaring a stack with await using

The Symbol.asyncDispose method is intended to be automatically called in an await using declaration.

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

Specifications

See also