Package Exports

@stdlib/utils-property-descriptors

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/utils-property-descriptors) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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': {...} }

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.

License

See LICENSE.

@stdlib/utils-property-descriptors