aboutsummaryrefslogtreecommitdiff
path: root/node_modules/well-known-symbols/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/well-known-symbols/README.md')
-rw-r--r--node_modules/well-known-symbols/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/node_modules/well-known-symbols/README.md b/node_modules/well-known-symbols/README.md
new file mode 100644
index 000000000..e4152293a
--- /dev/null
+++ b/node_modules/well-known-symbols/README.md
@@ -0,0 +1,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
+```