README.md 2.24 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
# object.entries <sup>[![Version Badge][npm-version-svg]][package-url]</sup>

[![Build Status][travis-svg]][travis-url]
[![dependency status][deps-svg]][deps-url]
[![dev dependency status][dev-deps-svg]][dev-deps-url]
[![License][license-image]][license-url]
[![Downloads][downloads-image]][downloads-url]

[![npm badge][npm-badge-png]][package-url]

[![browser support][testling-svg]][testling-url]

An ES2017 spec-compliant `Object.entries` shim. Invoke its "shim" method to shim `Object.entries` if it is unavailable or noncompliant.

This 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://tc39.github.io/ecma262/#sec-object.entries).

Most common usage:
```js
var assert = require('assert');
var entries = require('object.entries');

var obj = { a: 1, b: 2, c: 3 };
var expected = [['a', 1], ['b', 2], ['c', 3]];

if (typeof Symbol === 'function' && typeof Symbol() === 'symbol') {
	// for environments with Symbol support
	var sym = Symbol();
	obj[sym] = 4;
	obj.d = sym;
	expected.push(['d', sym]);
}

assert.deepEqual(entries(obj), expected);

if (!Object.entries) {
	entries.shim();
}

assert.deepEqual(Object.entries(obj), expected);
```

## Tests
Simply clone the repo, `npm install`, and run `npm test`

[package-url]: https://npmjs.com/package/object.entries
[npm-version-svg]: http://versionbadg.es/es-shims/Object.entries.svg
[travis-svg]: https://travis-ci.org/es-shims/Object.entries.svg
[travis-url]: https://travis-ci.org/es-shims/Object.entries
[deps-svg]: https://david-dm.org/es-shims/Object.entries.svg
[deps-url]: https://david-dm.org/es-shims/Object.entries
[dev-deps-svg]: https://david-dm.org/es-shims/Object.entries/dev-status.svg
[dev-deps-url]: https://david-dm.org/es-shims/Object.entries#info=devDependencies
[testling-svg]: https://ci.testling.com/es-shims/Object.entries.png
[testling-url]: https://ci.testling.com/es-shims/Object.entries
[npm-badge-png]: https://nodei.co/npm/object.entries.png?downloads=true&stars=true
[license-image]: http://img.shields.io/npm/l/object.entries.svg
[license-url]: LICENSE
[downloads-image]: http://img.shields.io/npm/dm/object.entries.svg
[downloads-url]: http://npm-stat.com/charts.html?package=object.entries