propertyDescriptors

Return an object's own property descriptors.

Installation

npm install @stdlib/utils-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': {...} }

See Also

• @stdlib/utils-define-property: define (or modify) an object property.
• @stdlib/utils-define-properties: define (and/or modify) object properties.
• @stdlib/utils-property-descriptor: return a property descriptor for an object's own property.
• @stdlib/utils-property-descriptors-in: return an object's own and inherited property descriptors.
• @stdlib/utils-property-names: return an array of an object's own enumerable and non-enumerable property names.
• @stdlib/utils-property-symbols: return an array of an object's own 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.