propertyDescriptorIn

Return a property descriptor for an object's own or inherited property.

Installation

npm install @stdlib/utils-property-descriptor-in

Usage

var propertyDescriptorIn = require( '@stdlib/utils-property-descriptor-in' );

propertyDescriptorIn( obj, property )

Returns a property descriptor for an object's own or inherited property.

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

var desc = propertyDescriptorIn( obj, 'a' );
// returns {'configurable':true,'enumerable':true,'writable':true,'value':1}

Notes

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

  • If provided null or undefined, the function returns null, rather than throwing an error.
  • If an object does not have a provided property, the function returns null, rather than undefined.

Examples

var defineProperty = require( '@stdlib/utils-define-property' );
var propertyDescriptorIn = require( '@stdlib/utils-property-descriptor-in' );

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 = propertyDescriptorIn( obj, 'foo' );

console.log( desc );
// => {'configurable':true,'enumerable':true,'writable':true,'value':['bar']}

See Also

• @stdlib/assert-has-property: test if an object has a specified property, either own or inherited.
• @stdlib/utils-define-property: define (or modify) an object property.
• @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.

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.