# es6-symbol

> ECMAScript 6 Symbol polyfill

Latest version **3.1.4** (published 2024-03-01) · ISC license · 0 weekly downloads

## Install

```sh
npm install es6-symbol
pnpm add es6-symbol
yarn add es6-symbol
bun add es6-symbol
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.1.4 |
| Published | 2024-03-01 |
| First published | 2013-11-15 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.12 |
| Dependencies | 2 |
| Unpacked size | 16.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 179 |
| Author | Mariusz Nowak |
| Maintainers | medikoo |
| Keywords | symbol, private, property, es6, ecmascript, harmony, ponyfill, polyfill |

## Links

- npm: https://www.npmjs.com/package/es6-symbol
- Repository: https://github.com/medikoo/es6-symbol
- Homepage: https://github.com/medikoo/es6-symbol#readme
- Issues: https://github.com/medikoo/es6-symbol/issues
- npm.io page: https://npm.io/package/es6-symbol

## Dependencies (2)

- [d](https://npm.io/package/d.md) ^1.0.2
- [ext](https://npm.io/package/ext.md) ^1.7.0

## Recent versions

- 3.1.4 (latest) — 2024-03-01
- 3.1.3 — 2019-10-29
- 3.1.2 — 2019-09-04
- 3.1.1 — 2017-03-15
- 3.1.0 — 2016-06-03
- 3.0.2 — 2015-12-12
- 3.0.1 — 2015-10-22
- 3.0.0 — 2015-10-02
- 2.0.1 — 2015-01-28
- 2.0.0 — 2015-01-28
- 1.0.0 — 2015-01-26
- 0.1.1 — 2014-10-07
- 0.1.0 — 2014-04-28
- 0.0.0 — 2013-11-15

## README

[![Build status][build-image]][build-url]
[![Tests coverage][cov-image]][cov-url]
[![npm version][npm-image]][npm-url]

# es6-symbol

## ECMAScript 6 Symbol polyfill

For more information about symbols see following links

- [Symbols in ECMAScript 6 by Axel Rauschmayer](http://www.2ality.com/2014/12/es6-symbols.html)
- [MDN Documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol)
- [Specification](https://tc39.github.io/ecma262/#sec-symbol-objects)

### Limitations

Underneath it uses real string property names which can easily be retrieved, however accidental collision with other property names is unlikely.

### Usage

If you'd like to use native version when it exists and fallback to [ponyfill](https://ponyfill.com) if it doesn't, use _es6-symbol_ as following:

```javascript
var Symbol = require("es6-symbol");
```

If you want to make sure your environment implements `Symbol` globally, do:

```javascript
require("es6-symbol/implement");
```

If you strictly want to use polyfill even if native `Symbol` exists (hard to find a good reason for that), do:

```javascript
var Symbol = require("es6-symbol/polyfill");
```

#### API

Best is to refer to [specification](https://tc39.github.io/ecma262/#sec-symbol-objects). Still if you want quick look, follow examples:

```javascript
var Symbol = require("es6-symbol");

var symbol = Symbol("My custom symbol");
var x = {};

x[symbol] = "foo";
console.log(x[symbol]);
("foo");

// Detect iterable:
var iterator, result;
if (possiblyIterable[Symbol.iterator]) {
  iterator = possiblyIterable[Symbol.iterator]();
  result = iterator.next();
  while (!result.done) {
    console.log(result.value);
    result = iterator.next();
  }
}
```

### Installation

#### NPM

In your project path:

    $ npm install es6-symbol

##### Browser

To port it to Browser or any other (non CJS) environment, use your favorite CJS bundler. No favorite yet? Try: [Browserify](http://browserify.org/), [Webmake](https://github.com/medikoo/modules-webmake) or [Webpack](http://webpack.github.io/)

## Tests

    $ npm test

## Security contact information

To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure.

---

<div align="center">
	<b>
		<a href="https://tidelift.com/subscription/pkg/npm-es6-symbol?utm_source=npm-es6-symbol&utm_medium=referral&utm_campaign=readme">Get professional support for d with a Tidelift subscription</a>
	</b>
	<br>
	<sub>
		Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
	</sub>
</div>

[build-image]: https://github.com/medikoo/es6-symbol/workflows/Integrate/badge.svg
[build-url]: https://github.com/medikoo/es6-symbol/actions?query=workflow%3AIntegrate
[cov-image]: https://img.shields.io/codecov/c/github/medikoo/es6-symbol.svg
[cov-url]: https://codecov.io/gh/medikoo/es6-symbol
[npm-image]: https://img.shields.io/npm/v/es6-symbol.svg
[npm-url]: https://www.npmjs.com/package/es6-symbol

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