inheritedProperties

Return an array of an object's inherited property names and symbols.

Installation

npm install @stdlib/utils-inherited-properties

Usage

var inheritedProperties = require( '@stdlib/utils-inherited-properties' );

inheritedProperties( obj[, level] )

Returns an array of an object's inherited property names and symbols.

var props = inheritedProperties( [ 1, 2, 3 ] );
// returns [...]

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

var props = inheritedProperties( [ 1, 2, 3 ], 1 );

Examples

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

var hasSymbols = hasSymbolSupport();

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

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

var obj = new Foo();
var props = inheritedProperties( obj );
// returns [ ..., 'c', 'bip', ... ]

See Also

• @stdlib/utils-properties: return an array of an object's own enumerable and non-enumerable property names and symbols.
• @stdlib/utils-properties-in: return an array of an object's own and inherited property names and symbols.
• @stdlib/utils-inherited-property-names: return an array of an object's inherited enumerable and non-enumerable property names.
• @stdlib/utils-inherited-property-symbols: return an array of an object's inherited symbol properties.

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.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.