well-known-symbols

well-known-symbols

An ESnext spec-compliant shim/polyfill/replacement for all Well-Known Symbols that works in any environment with Symbols.

New Well-Known Symbols will be added after they reach stage 3.

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

Note: functionality provided by this package prior to v4 can be found in:

• https://www.npmjs.com/package/is-registered-symbol
• https://www.npmjs.com/package/is-well-known-symbol

Getting started

npm install --save well-known-symbols

Usage/Examples

const assert = require('assert');

require('well-known-symbols/auto');

assert.equal(typeof Symbol.asyncIterator, 'symbol');
assert.equal(typeof Symbol.hasInstance, 'symbol');
assert.equal(typeof Symbol.isConcatSpreadable, 'symbol');
assert.equal(typeof Symbol.iterator, 'symbol');
assert.equal(typeof Symbol.match, 'symbol');
assert.equal(typeof Symbol.matchAll, 'symbol');
assert.equal(typeof Symbol.replace, 'symbol');
assert.equal(typeof Symbol.search, 'symbol');
assert.equal(typeof Symbol.species, 'symbol');
assert.equal(typeof Symbol.split, 'symbol');
assert.equal(typeof Symbol.toPrimitive, 'symbol');
assert.equal(typeof Symbol.toStringTag, 'symbol');
assert.equal(typeof Symbol.unscopables, 'symbol');

Tests

Clone the repo, npm install, and run npm test

Changelog

v4.1.0 - 2025-01-06

Commits

• [New] add Symbol.dispose, Symbol.asyncDispose 303b0a6
• [Dev Deps] update @es-shims/api, @ljharb/eslint-config, auto-changelog, is-registered-symbol, is-symbol, is-well-known-symbol, npmignore, tape 7316942
• [Deps] update get-intrinsic, has-symbols 7f58dbd
• [Dev Deps] update @es-shims/api 2e14122
• [meta] add missing engines.node c14741e
• [Tests] replace aud with npm audit 828e18f
• [meta] add prepublishOnly script cbd7521
• [Dev Deps] add missing peer dep f178b97