Installation

npm install @stdlib/utils-entries

Alternatively,

• To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch.
• If you are using Deno, visit the deno branch.
• For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch.

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

Usage

var objectEntries = require( '@stdlib/utils-entries' );

objectEntries( obj )

Returns an array of an object's own enumerable property [key, value] pairs.

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

var entries = objectEntries( obj );
// e.g., returns [ ['a', 1], ['b', 2] ]

Notes

• Entry order is not guaranteed, as object key enumeration is not specified according to the ECMAScript specification. In practice, however, most engines use insertion order to sort an object's keys, thus allowing for deterministic return values.

Examples

var objectEntries = require( '@stdlib/utils-entries' );

var obj = {
    'beep': 'boop',
    'a': {
        'b': 'c'
    },
    'foo': [ 'bar' ]
};

var entries = objectEntries( obj );
// e.g., returns [ ['beep', 'boop'], ['a', {'b':'c'}], ['foo', [ 'bar' ]] ]

See Also

• @stdlib/utils/entries-in: return an array of an object's own and inherited enumerable property key-value pairs.
• @stdlib/utils/from-entries: create an object from key-value pairs.
• @stdlib/utils/keys: return an array of an object's own enumerable property names.
• @stdlib/utils/values: return an array of an object's own enumerable property values.

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-2022. The Stdlib Authors.