ECMAScript 6 Symbol polyfill
npm install es6-symbol[![Build status][build-image]][build-url]
[![Tests coverage][cov-image]][cov-url]
[![npm version][npm-image]][npm-url]
For more information about symbols see following links
- Symbols in ECMAScript 6 by Axel Rauschmayer
- MDN Documentation
- Specification
Underneath it uses real string property names which can easily be retrieved, however accidental collision with other property names is unlikely.
If you'd like to use native version when it exists and fallback to ponyfill 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. 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();
}
}
``
#### 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, Webmake or Webpack
$ npm test
To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.
---
[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