# propertyDescriptor
[![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.
## Installation
```bash
npm install @stdlib/utils-property-descriptor
```
## Usage
```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}
```
## 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
```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'}
```
* * *
## Notice
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]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2022. 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
[test-url]: https://github.com/stdlib-js/utils-property-descriptor/actions/workflows/test.yml
[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
[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
[umd-url]: https://github.com/stdlib-js/utils-property-descriptor/tree/umd
[esm-url]: https://github.com/stdlib-js/utils-property-descriptor/tree/esm
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://gitter.im/stdlib-js/stdlib/
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[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