@fav/prop.enum-own-symbols

Lists enumerable own 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-own-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-own-symbols/ directory manually.

Usage

For Node.js:

var enumOwnSymbols = require('@fav/prop.enum-own-symbols');

var symbol = Symbol('foo');
var obj0 = {}, obj1 = {}, obj2 = {};

obj0[symbol] = 123;
enumOwnSymbols(obj0); // => [ Symbol(foo) ]

Object.defineProperty(obj1, symbol, { value: 1 });
enumOwnSymbols(obj1); // => []

var Fn2 = function() {}
Fn2.prototype = obj0;
var fn2 = new Fn2();
fn2[symbol]; // => 123
enumOwnSymbols(fn2); // => []

For Web browsers:

<script src="fav.prop.enum-own-symbols.min.js"></script>
<script>
var enumOwnSymbols = fav.prop.enumOwnSymbols;
var symbol = Symbol('foo');

obj0[symbol] = 123;
enumOwnSymbols(obj0); // => [ Symbol(foo) ]
</script>

API

enumOwnSymbols(obj) : Array

Lists enumerable own property symbols of a given object.

This function returns an empty array if obj 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.