aboutsummaryrefslogtreecommitdiff
path: root/node_modules/well-known-symbols/README.md
blob: e4152293ac53cc86bb6785ad409b157bd4fbdb5d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# well-known-symbols

Check whether a symbol is [well-known](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Symbol#Well-known_symbols).

Requires Node.js 4 or above. Note that not all Node.js versions support the same
well-known symbols.

## Installation

```console
$ npm install --save well-known-symbols
```

## Usage

```js
const wellKnownSymbols = require('well-known-symbols')

wellKnownSymbols.isWellKnown(Symbol.iterator) // true
wellKnownSymbols.isWellKnown(Symbol()) // false

wellKnownSymbols.getLabel(Symbol.iterator) // 'Symbol.iterator'
wellKnownSymbols.getLabel(Symbol()) // undefined
```