time-to-botec/js/node_modules/@stdlib/utils/property-descriptors/README.md
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

2.2 KiB

propertyDescriptors

Return an object's own property descriptors.

Usage

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

propertyDescriptors( obj )

Returns an object's own property descriptors.

var obj = {
    'a': 1,
    'b': 2
};

var desc = propertyDescriptors( obj );
// returns { 'a': {...}, 'b': {...} }

Notes

  • This function differs from the built-in Object.getOwnPropertyDescriptors() as follows:

    • 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 propertyDescriptors = require( '@stdlib/utils/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 = propertyDescriptors( obj );

console.log( desc );
// => { 'beep': {...}, 'a': {...}, 'baz': {...} }