@stdlib/utils-property-names

Return an array of an object's own enumerable and non-enumerable property names.

Usage no npm install needed!

<script type="module">
  import stdlibUtilsPropertyNames from 'https://cdn.skypack.dev/@stdlib/utils-property-names';
</script>

README

propertyNames

NPM version Build Status Coverage Status

Return an array of an object's own enumerable and non-enumerable property names.

Installation

npm install @stdlib/utils-property-names

Usage

var propertyNames = require( '@stdlib/utils-property-names' );

propertyNames( obj )

Returns an array of an object's own enumerable and non-enumerable property names.

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

var keys = propertyNames( obj );
// e.g., returns [ 'a', 'b' ]

Notes

  • 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 an object's keys, thus allowing for deterministic extraction.
  • In contrast to the built-in Object.getOwnPropertyNames(), if provided null or undefined, the function returns an empty array, rather than throwing an error.

Examples

var defineProperty = require( '@stdlib/utils-define-property' );
var propertyNames = require( '@stdlib/utils-property-names' );

function Foo() {
    this.beep = 'boop';
    this.a = {
        'b': 'c'
    };
    defineProperty( this, 'baz', {
        'value': 'qux',
        'configurable': true,
        'writable': true,
        'enumerable': false
    });
    return this;
}

Foo.prototype.foo = [ 'bar' ];

var obj = new Foo();
var keys = propertyNames( obj );

console.log( keys );
// e.g., => [ 'beep', 'a', 'baz' ]

See Also

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

Chat

License

See LICENSE.

Copyright

Copyright © 2016-2022. The Stdlib Authors.