# well-known-symbols

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

Latest version **4.1.0** (published 2025-01-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install well-known-symbols
pnpm add well-known-symbols
yarn add well-known-symbols
bun add well-known-symbols
```

## Health

**Score 30/100 (F)** — status: maintenance-mode.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.1.0 |
| Published | 2025-01-07 |
| First published | 2017-02-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >= 0.4 |
| Dependencies | 2 |
| Unpacked size | 33.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Jordan Harband |
| Maintainers | ljharb, novemberborn |
| Keywords | javascript, ecmascript, polyfill, shim, well-known, symbol, Symbol.asyncIterator, asyncIterator, Symbol.hasInstance, hasInstance, Symbol.isConcatSpreadable, isConcatSpreadable, Symbol.iterator, iterator, Symbol.match, match, Symbol.matchAll, matchAll, Symbol.replace, replace, Symbol.search, search, Symbol.species, species, Symbol.split, split, Symbol.toPrimitive, toPrimitive, Symbol.toStringTag, toStringTag, Symbol.unscopables, unscopables |

## Links

- npm: https://www.npmjs.com/package/well-known-symbols
- Repository: https://github.com/es-shims/well-known-symbols
- Homepage: https://github.com/es-shims/well-known-symbols#readme
- Issues: https://github.com/es-shims/well-known-symbols/issues
- npm.io page: https://npm.io/package/well-known-symbols

## Dependencies (2)

- [has-symbols](https://npm.io/package/has-symbols.md) ^1.1.0
- [get-intrinsic](https://npm.io/package/get-intrinsic.md) ^1.2.7

## Alternatives

- [byte-size](https://npm.io/package/byte-size.md) — 2.1M weekly downloads
- [speed-limiter](https://npm.io/package/speed-limiter.md) — 16.0K weekly downloads
- [@powersync/node](https://npm.io/package/@powersync/node.md) — 10.9K weekly downloads
- [@ledgerhq/coin-cardano](https://npm.io/package/@ledgerhq/coin-cardano.md) — 1.0K weekly downloads
- [@jayesol/jayeson.lib.streamfinder](https://npm.io/package/@jayesol/jayeson.lib.streamfinder.md) — 1.0K weekly downloads

## Recent versions

- 4.1.0 (latest) — 2025-01-07
- 4.0.0 — 2023-03-07
- 3.0.0 — 2020-02-01
- 2.0.0 — 2018-09-16
- 1.0.0 — 2017-02-27

## README

# well-known-symbols <sup>[![Version Badge][npm-version-svg]][package-url]</sup>

[![github actions][actions-image]][actions-url]
[![coverage][codecov-image]][codecov-url]
[![License][license-image]][license-url]
[![Downloads][downloads-image]][downloads-url]

[![npm badge][npm-badge-png]][package-url]

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](https://github.com/es-shims/api) “multi” interface. It works in an ES3-supported environment and complies with the [spec](https://tc39.es/ecma262/#sec-well-known-symbols).

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

```sh
npm install --save well-known-symbols
```

## Usage/Examples

```js
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`

[package-url]: https://npmjs.org/package/well-known-symbols
[npm-version-svg]: https://versionbadg.es/es-shims/well-known-symbols.svg
[deps-svg]: https://david-dm.org/es-shims/well-known-symbols.svg
[deps-url]: https://david-dm.org/es-shims/well-known-symbols
[dev-deps-svg]: https://david-dm.org/es-shims/well-known-symbols/dev-status.svg
[dev-deps-url]: https://david-dm.org/es-shims/well-known-symbols#info=devDependencies
[npm-badge-png]: https://nodei.co/npm/well-known-symbols.png?downloads=true&stars=true
[license-image]: https://img.shields.io/npm/l/well-known-symbols.svg
[license-url]: LICENSE
[downloads-image]: https://img.shields.io/npm/dm/well-known-symbols.svg
[downloads-url]: https://npm-stat.com/charts.html?package=well-known-symbols
[codecov-image]: https://codecov.io/gh/es-shims/well-known-symbols/branch/main/graphs/badge.svg
[codecov-url]: https://app.codecov.io/gh/es-shims/well-known-symbols/
[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/es-shims/well-known-symbols
[actions-url]: https://github.com/es-shims/well-known-symbols/actions

---
_Source: https://npm.io/package/well-known-symbols · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._