Return a property descriptor for an object's own property.
npm install @stdlib/utils-property-descriptorWe believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js. The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases. When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there. To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Return a property descriptor for an object's own property.
``bash`
npm install @stdlib/utils-property-descriptor
`javascript`
var propertyDescriptor = require( '@stdlib/utils-property-descriptor' );
#### propertyDescriptor( obj, property )
Returns a property descriptor for an object's own property.
`javascript
var obj = {
'a': 1,
'b': 2
};
var desc = propertyDescriptor( obj, 'a' );
// returns {'configurable':true,'enumerable':true,'writable':true,'value':1}
`
- 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.null
- If an object does not have a provided property, the function returns , rather than undefined.
`javascript
var defineProperty = require( '@stdlib/utils-define-property' );
var propertyDescriptor = require( '@stdlib/utils-property-descriptor' );
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 = propertyDescriptor( obj, 'baz' );
console.log( desc );
// => {'configurable':true,'enumerable':false,'writable':true,'value':'qux'}
`
*
- [@stdlib/assert-has-own-property][@stdlib/assert/has-own-property]: test if an object has a specified property.
- [@stdlib/utils-define-property][@stdlib/utils/define-property]: define (or modify) an object property.
- [@stdlib/utils-property-descriptor-in][@stdlib/utils/property-descriptor-in]: return a property descriptor for an object's own or inherited property.
- [@stdlib/utils-property-descriptors][@stdlib/utils/property-descriptors]: return an object's own property descriptors.
*
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/utils-property-descriptor.svg
[npm-url]: https://npmjs.org/package/@stdlib/utils-property-descriptor
[test-image]: https://github.com/stdlib-js/utils-property-descriptor/actions/workflows/test.yml/badge.svg?branch=v0.2.3
[test-url]: https://github.com/stdlib-js/utils-property-descriptor/actions/workflows/test.yml?query=branch:v0.2.3
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-property-descriptor/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/utils-property-descriptor?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/utils-property-descriptor/tree/deno
[deno-readme]: https://github.com/stdlib-js/utils-property-descriptor/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/utils-property-descriptor/tree/umd
[umd-readme]: https://github.com/stdlib-js/utils-property-descriptor/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/utils-property-descriptor/tree/esm
[esm-readme]: https://github.com/stdlib-js/utils-property-descriptor/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/utils-property-descriptor/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-property-descriptor/main/LICENSE
[@stdlib/assert/has-own-property]: https://www.npmjs.com/package/@stdlib/assert-has-own-property
[@stdlib/utils/define-property]: https://www.npmjs.com/package/@stdlib/utils-define-property
[@stdlib/utils/property-descriptor-in]: https://www.npmjs.com/package/@stdlib/utils-property-descriptor-in
[@stdlib/utils/property-descriptors]: https://www.npmjs.com/package/@stdlib/utils-property-descriptors