Return an array of an object's own enumerable property names and symbols.
npm install @stdlib/utils-enumerable-properties
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 enumerableProperties = require( '@stdlib/utils-enumerable-properties' );
Returns an array
of an object's own enumerable property names and symbols.
var obj = { 'a': 1, 'b': 2 }; var props = enumerableProperties( obj ); // e.g., returns [ 'a', 'b' ]
- Property order is not guaranteed, as
object
property enumeration is not specified according to the ECMAScript specification. In practice, however, most engines use insertion order to sort anobject
's properties, thus allowing for deterministic extraction.
var defineProperty = require( '@stdlib/utils-define-property' ); var hasSymbolSupport = require( '@stdlib/assert-has-symbol-support' ); var Symbol = require( '@stdlib/symbol-ctor' ); var enumerableProperties = require( '@stdlib/utils-enumerable-properties' ); var hasSymbols = hasSymbolSupport(); var props; var obj; function Foo() { this.a = 'a'; defineProperty( this, 'b', { 'configurable': true, 'enumerable': false, 'writable': true, 'value': 'b' }); if ( hasSymbols ) { this[ Symbol( 'a' ) ] = 'a'; defineProperty( this, Symbol( 'b' ), { 'configurable': true, 'enumerable': false, 'writable': true, 'value': 'b' }); } return this; } Foo.prototype.c = 'c'; if ( hasSymbols ) { Foo.prototype[ Symbol( 'c' ) ] = 'c'; } obj = new Foo(); props = enumerableProperties( obj ); console.log( props ); // e.g., => [ 'a', ... ]
@stdlib/utils/enumerable-properties-in
: return an array of an object's own and inherited enumerable property names and symbols.@stdlib/utils/enumerable-property-symbols
: return an array of an object's own enumerable symbol properties.@stdlib/utils/inherited-enumerable-properties
: return an array of an object's inherited enumerable property names and symbols.@stdlib/utils/keys
: return an array of an object's own enumerable property names.@stdlib/utils/nonenumerable-properties
: return an array of an object's own non-enumerable property names and symbols.@stdlib/utils/properties
: return an array of an object's own enumerable and non-enumerable property names and symbols.
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.