@stdlib/utils-inherited-property-descriptors

Return an object's inherited property descriptors.


Keywords
stdlib, stdutils, stdutil, utilities, utility, utils, util, object, obj, descriptors, descriptor, desc, inherited, properties, props, es7, javascript, node, node-js, nodejs
License
Apache-2.0
Install
npm install @stdlib/utils-inherited-property-descriptors@0.0.6

Documentation

inheritedPropertyDescriptors

NPM version Build Status Coverage Status dependencies

Return an object's inherited property descriptors.

Installation

npm install @stdlib/utils-inherited-property-descriptors

Usage

var inheritedPropertyDescriptors = require( '@stdlib/utils-inherited-property-descriptors' );

inheritedPropertyDescriptors( obj[, level] )

Returns an object's inherited property descriptors.

function Foo() {
    this.a = 'b';
    return this;
}

Foo.prototype.beep = 'boop';

var f = new Foo();
var desc = inheritedPropertyDescriptors( f );
// returns { 'beep': {...}, ... }

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

var inherit = require( '@stdlib/utils-inherit' );

function Bar() {
    return this;
}

Bar.prototype.boop = 'beep';

function Foo() {
    Bar.call( this );
    this.a = 'b';
    return this;
}

inherit( Foo, Bar );
Foo.prototype.beep = 'boop';

var f = new Foo();
var desc = inheritedPropertyDescriptors( f, 1 );
// returns { 'beep': {...}, ... }

Notes

  • In contrast to the built-in Object.getOwnPropertyDescriptors(), if provided null or undefined, the function returns an empty object, rather than throwing an error.

Examples

var defineProperty = require( '@stdlib/utils-define-property' );
var inheritedPropertyDescriptors = require( '@stdlib/utils-inherited-property-descriptors' );

function Foo() {
    this.beep = 'boop';
    this.a = {
        'b': 'c'
    };
    defineProperty( this, 'baz', {
        'value': 'qux',
        'configurable': true,
        'writable': true,
        'enumerable': false
    });
    return this;
}

Foo.prototype.foo = [ 'bar' ];

var obj = new Foo();
var desc = inheritedPropertyDescriptors( obj );

console.log( desc );
// => { 'foo': {...}, ... }

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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.