README.md
1#object.getownpropertydescriptors <sup>[![Version Badge][npm-version-svg]][package-url]</sup>
2
3[![Build Status][travis-svg]][travis-url]
4[![dependency status][deps-svg]][deps-url]
5[![dev dependency status][dev-deps-svg]][dev-deps-url]
6[![License][license-image]][license-url]
7[![Downloads][downloads-image]][downloads-url]
8
9[![npm badge][npm-badge-png]][package-url]
10
11[![browser support][testling-svg]][testling-url]
12
13An ES2017 spec-compliant shim for `Object.getOwnPropertyDescriptors` that works in ES5.
14Invoke its "shim" method to shim `Object.getOwnPropertyDescriptors` if it is unavailable, and if `Object.getOwnPropertyDescriptor` is available.
15
16This package implements the [es-shim API](https://github.com/es-shims/api) interface. It works in an ES3-supported environment and complies with the [spec](https://github.com/tc39/ecma262/pull/582).
17
18## Example
19
20```js
21var getDescriptors = require('object.getownpropertydescriptors');
22var assert = require('assert');
23var obj = { normal: Infinity };
24var enumDescriptor = {
25 enumerable: false,
26 writable: false,
27 configurable: true,
28 value: true
29};
30var writableDescriptor = {
31 enumerable: true,
32 writable: true,
33 configurable: true,
34 value: 42
35};
36var symbol = Symbol();
37var symDescriptor = {
38 enumerable: true,
39 writable: true,
40 configurable: false,
41 value: [symbol]
42};
43
44Object.defineProperty(obj, 'enumerable', enumDescriptor);
45Object.defineProperty(obj, 'writable', writableDescriptor);
46Object.defineProperty(obj, 'symbol', symDescriptor);
47
48var descriptors = getDescriptors(obj);
49
50assert.deepEqual(descriptors, {
51 normal: {
52 enumerable: true,
53 writable: true,
54 configurable: true,
55 value: Infinity
56 },
57 enumerable: enumDescriptor,
58 writable: writableDescriptor,
59 symbol: symDescriptor
60});
61```
62
63```js
64var getDescriptors = require('object.getownpropertydescriptors');
65var assert = require('assert');
66/* when Object.getOwnPropertyDescriptors is not present */
67delete Object.getOwnPropertyDescriptors;
68var shimmedDescriptors = getDescriptors.shim();
69assert.equal(shimmedDescriptors, getDescriptors);
70assert.deepEqual(shimmedDescriptors(obj), getDescriptors(obj));
71```
72
73```js
74var getDescriptors = require('object.getownpropertydescriptors');
75var assert = require('assert');
76/* when Object.getOwnPropertyDescriptors is present */
77var shimmedDescriptors = getDescriptors.shim();
78assert.notEqual(shimmedDescriptors, getDescriptors);
79assert.deepEqual(shimmedDescriptors(obj), getDescriptors(obj));
80```
81
82## Tests
83Simply clone the repo, `npm install`, and run `npm test`
84
85[package-url]: https://npmjs.org/package/object.getownpropertydescriptors
86[npm-version-svg]: http://versionbadg.es/ljharb/object.getownpropertydescriptors.svg
87[travis-svg]: https://travis-ci.org/ljharb/object.getownpropertydescriptors.svg
88[travis-url]: https://travis-ci.org/ljharb/object.getownpropertydescriptors
89[deps-svg]: https://david-dm.org/ljharb/object.getownpropertydescriptors.svg
90[deps-url]: https://david-dm.org/ljharb/object.getownpropertydescriptors
91[dev-deps-svg]: https://david-dm.org/ljharb/object.getownpropertydescriptors/dev-status.svg
92[dev-deps-url]: https://david-dm.org/ljharb/object.getownpropertydescriptors#info=devDependencies
93[testling-svg]: https://ci.testling.com/ljharb/object.getownpropertydescriptors.png
94[testling-url]: https://ci.testling.com/ljharb/object.getownpropertydescriptors
95[npm-badge-png]: https://nodei.co/npm/object.getownpropertydescriptors.png?downloads=true&stars=true
96[license-image]: http://img.shields.io/npm/l/object.getownpropertydescriptors.svg
97[license-url]: LICENSE
98[downloads-image]: http://img.shields.io/npm/dm/object.getownpropertydescriptors.svg
99[downloads-url]: http://npm-stat.com/charts.html?package=object.getownpropertydescriptors
100