aboutsummaryrefslogtreecommitdiff
path: root/node_modules/get-own-enumerable-property-symbols/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/get-own-enumerable-property-symbols/README.md')
-rw-r--r--node_modules/get-own-enumerable-property-symbols/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/node_modules/get-own-enumerable-property-symbols/README.md b/node_modules/get-own-enumerable-property-symbols/README.md
new file mode 100644
index 000000000..102ae8aa7
--- /dev/null
+++ b/node_modules/get-own-enumerable-property-symbols/README.md
@@ -0,0 +1,17 @@
+# get-own-enumerable-property-symbols [![Build Status](https://travis-ci.org/mightyiam/get-own-enumerable-property-symbols.svg?branch=master)](https://travis-ci.org/mightyiam/get-own-enumerable-property-symbols)
+
+Returns an array of all *enumerable* symbol properties found directly upon a given object.
+
+Similar to [`Object.getOwnPropertySymbols`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/getOwnPropertySymbols)
+but only [enumerable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Enumerability_and_ownership_of_properties) keys.
+
+```js
+const getOwnEnumPropSymbols = require('get-own-enumerable-property-symbols')
+
+getOwnEnumPropSymbols({ [Symbol()]: undefined })
+// [Symbol()]
+getOwnEnumPropSymbols(Object.defineProperty({}, Symbol(), {enumerable: false}))
+// []
+```
+
+[![JavaScript Style Guide](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)