@stdlib/utils-inherited-enumerable-property-symbol

inheritedEnumerablePropertySymbols

Return an array of an object's inherited enumerable symbol properties.

Installation

npm install @stdlib/utils-inherited-enumerable-property-symbols

Usage

var inheritedEnumerablePropertySymbols = require( '@stdlib/utils-inherited-enumerable-property-symbols' );

inheritedEnumerablePropertySymbols( obj[, level] )

Returns an array of an object's inherited enumerable symbol properties.

var hasSymbolSupport = require( '@stdlib/assert-has-symbol-support' );
var Symbol = require( '@stdlib/symbol-ctor' );

var hasSymbols = hasSymbolSupport();
var symbols;
var f;

function Foo() {
    if ( hasSymbols ) {
        this[ Symbol( 'a' ) ] = 'a';
    }
    return this;
}

if ( hasSymbols ) {
    Foo.prototype[ Symbol( 'b' ) ] = 'b';
}

f = new Foo();
symbols = inheritedEnumerablePropertySymbols( f );

By default, the function walks an object's entire prototype chain. To limit the inheritance level, provide a level argument.

var symbols = inheritedEnumerablePropertySymbols( [], 1 );

Notes

Property order is not guaranteed, as object property enumeration is not specified according to the ECMAScript specification. In practice, however, most engines use insertion order to sort an object's properties, thus allowing for deterministic extraction.

Examples

var defineProperty = require( '@stdlib/utils-define-property' );
var hasSymbolSupport = require( '@stdlib/assert-has-symbol-support' );
var Symbol = require( '@stdlib/symbol-ctor' );
var inheritedEnumerablePropertySymbols = require( '@stdlib/utils-inherited-enumerable-property-symbols' );

var hasSymbols = hasSymbolSupport();
var symbols;
var obj;

function Foo() {
    this.a = 'a';
    defineProperty( this, 'b', {
        'configurable': false,
        'enumerable': false,
        'writable': true,
        'value': 'b'
    });
    if ( hasSymbols ) {
        this[ Symbol( 'a' ) ] = 'a';
        defineProperty( this, Symbol( 'b' ), {
            'configurable': false,
            'enumerable': false,
            'writable': false,
            'value': 'b'
        });
    }
    return this;
}

Foo.prototype.c = 'c';
defineProperty( Foo.prototype, 'd', {
    'configurable': false,
    'enumerable': false,
    'writable': false,
    'value': 'd'
});
if ( hasSymbols ) {
    Foo.prototype[ Symbol( 'c' ) ] = 'c';
    defineProperty( Foo.prototype, Symbol( 'd' ), {
        'configurable': false,
        'enumerable': false,
        'writable': false,
        'value': 'd'
    });
}

obj = new Foo();
symbols = inheritedEnumerablePropertySymbols( obj );

console.log( symbols );

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.