disposablestack

disposablestack

An ESnext spec-compliant DisposableStack, AsyncDisposableStack, Symbol.dispose, and Symbol.asyncDispose shim/polyfill/replacement that works as far down as ES3.

Its root auto entrypoint also provides SuppressedError, via the suppressed-error package.

This package implements the es-shim API “multi” interface. It works in an ES3-supported environment and complies with the proposed spec.

Getting started

npm install --save disposablestack

Usage/Examples

const assert = require('assert');

require('disposablestack/auto');

assert.equal(typeof Symbol.dispose, 'symbol');
assert.equal(typeof Symbol.asyncDispose, 'symbol');

const error = new SuppressedError();
assert.ok(error instanceof Error);

const stack = new DisposableStack();

const asyncStack = new AsyncDisposableStack();

// examples of stack methods

stack.dispose();

asyncStack.dispose();

// assert disposal was done

Tests

Clone the repo, npm install, and run npm test

Changelog

v1.1.1 - 2023-07-24

Commits

• [Deps] update es-abstract 4251c56
• [Refactor] empty out DisposableStack slot on dispose 4d67178
• [Tests] add some coverage 001e23c
• [readme] fix package name 52002d1
• [Tests] node v20.4 ships Symbol dispose polyfills that are registered symbols 37709d2
• [Dev Deps] update @es-shims/api, @ljharb/eslint-config, aud, tape 4716a40
• [Dev Deps] update tape 85c5033
• [Deps] update get-intrinsic a3b63e2