Return an array of an object's own enumerable property names.
npm install @stdlib/utils-keys
Alternatively,
- To load the package in a website via a
script
tag without installation and bundlers, use the ES Module available on theesm
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.
var objectKeys = require( '@stdlib/utils-keys' );
Returns an array
of an object's own enumerable property names.
var obj = {
'a': 1,
'b': 2
};
var keys = objectKeys( obj );
// e.g., returns [ 'a', 'b' ]
- Name 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 anobject
's keys, thus allowing for deterministic extraction. - In contrast to the built-in
Object.keys()
, if providednull
orundefined
, the function returns an emptyarray
, rather than throwing an error.
var objectKeys = require( '@stdlib/utils-keys' );
function Foo() {
this.beep = 'boop';
this.a = {
'b': 'c'
};
return this;
}
Foo.prototype.foo = [ 'bar' ];
var obj = new Foo();
var keys = objectKeys( obj );
console.log( keys );
// e.g., => [ 'beep', 'a' ]
@stdlib/utils/entries
: return an array of an object's own enumerable property key-value pairs.@stdlib/utils/keys-in
: return an array of an object's own and inherited enumerable property names.@stdlib/utils/nonindex-keys
: return an array of an object's own enumerable property names which are not integer indices.@stdlib/utils/values
: return an array of an object's own enumerable property values.
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.
See LICENSE.
Copyright © 2016-2022. The Stdlib Authors.