@fav/prop.enum-all-symbols
v1.0.2
Published
Lists enumerable own and inherited property symbols of an object.
Downloads
7
Maintainers
Readme
@fav/prop.enum-all-symbols
Lists enumerable own and inherited property symbols of an object.
"fav" is an abbreviation of "favorite" and also the acronym of "for all versions". This package is intended to support all Node.js versions and many browsers as possible. At least, this package supports Node.js >= v0.10 and major Web browsers: Chrome, Firefox, IE11, Edge, Vivaldi and Safari.
Install
To install from npm:
$ npm install --save @fav/prop.enum-all-symbols
NOTE: npm < 2.7.0 does not support scoped package, but old version Node.js supports it. So when you use such older npm, you should download this package from github.com, and move it in node_modules/@fav/prop.enum-all-symbols/
directory manually.
Usage
For Node.js:
var enumAllSymbols = require('@fav/prop.enum-all-symbols');
var symbol = Symbol('foo');
var obj0 = {}, obj1 = {}, obj2 = {};
obj0[symbol] = 123;
enumAllSymbols(obj0); // => [ Symbol(foo) ]
Object.defineProperty(obj1, symbol, { value: 1 });
enumAllSymbols(obj1); // => []
var Fn2 = function() {}
Fn2.prototype = obj0;
var fn2 = new Fn2();
fn2[symbol]; // => 123
enumAllSymbols(fn2); // => [ Symbol(foo) ]
For Web browsers:
<script src="fav.prop.enum-all-keys.min.js"></script>
<script>
var enumAllSymbols = fav.prop.enumAllSymbols;
var symbol = Symbol('foo');
obj0[symbol] = 123;
enumAllSymbols(obj0); // => [ Symbol(foo) ]
</script>
API
enumAllSymbols(obj) : Array
Lists enumerable own and inherited property symbols of the given object.
This function returns same result with Object.getOwnPropertySymbols
except that it returns an empty object when the argument is nullish.
Parameter:
| Parameter | Type | Description | |-----------|:------:|-----------------------------------------------| | obj | object | The object to be listed its property symbols. |
Return:
An array of property symbols.
Type: Array
Checked
Node.js (4〜)
| Platform | 4 | 5 | 6 | 7 | 8 | 9 | 10 | |:---------:|:------:|:------:|:------:|:------:|:------:|:------:|:------:| | macOS |◯|◯|◯|◯|◯|◯|◯| | Windows10 |◯|◯|◯|◯|◯|◯|◯| | Linux |◯|◯|◯|◯|◯|◯|◯|
io.js (1〜3)
| Platform | 1 | 2 | 3 | |:---------:|:------:|:------:|:------:| | macOS |◯|◯|◯| | Windows10 |◯|◯|◯| | Linux |◯|◯|◯|
Node.js (〜0.12)
| Platform | 0.8 | 0.9 | 0.10 | 0.11 | 0.12 | |:---------:|:------:|:------:|:------:|:------:|:------:| | macOS |◯|◯|◯|◯|◯| | Windows10 |◯|◯|◯|◯|◯| | Linux |◯|◯|◯|◯|◯|
Web browsers
| Platform | Chrome | Firefox | Vivaldi | Safari | Edge | IE11 | |:---------:|:------:|:-------:|:-------:|:------:|:------:|:------:| | macOS |◯|◯ |◯ |◯| -- | -- | | Windows10 |◯|◯ |◯ | -- |◯|◯| | Linux |◯|◯ |◯ | -- | -- | -- |
License
Copyright (C) 2017-2018 Takayuki Sato
This program is free software under MIT License. See the file LICENSE in this distribution for more details.