isEnumerableProperty
Test if an object's own property is enumerable.
Installation
npm install @stdlib/assert-is-enumerable-property
Usage
var isEnumerableProperty = require( '@stdlib/assert-is-enumerable-property' );
isEnumerableProperty( value, property )
Returns a boolean
indicating if a value
has an enumerable property
.
var value = {
'beep': 'boop'
};
var bool = isEnumerableProperty( value, 'beep' );
bool = isEnumerableProperty( value, 'constructor' );
Notes
-
In contrast to the native Object.prototype.propertyIsEnumerable, this function does not throw when provided null
or undefined
. Instead, the function returns false
.
var bool = isEnumerableProperty( null, 'a' );
bool = isEnumerableProperty( void 0, 'a' );
-
Value arguments other than null
or undefined
are coerced to objects
.
var bool = isEnumerableProperty( 'beep', '1' );
-
Property arguments are coerced to strings
.
var value = {
'null': false
};
var bool = isEnumerableProperty( value, null );
value = {
'[object Object]': false
};
bool = isEnumerableProperty( value, {} );
Examples
var isEnumerableProperty = require( '@stdlib/assert-is-enumerable-property' );
var bool = isEnumerableProperty( { 'a': 'b' }, 'a' );
bool = isEnumerableProperty( [ 'a' ], 0 );
bool = isEnumerableProperty( [ 'a' ], 'length' );
bool = isEnumerableProperty( {}, 'toString' );
bool = isEnumerableProperty( {}, 'hasOwnProperty' );
bool = isEnumerableProperty( null, 'a' );
bool = isEnumerableProperty( void 0, 'a' );
bool = isEnumerableProperty( { 'null': false }, null );
bool = isEnumerableProperty( { '[object Object]': false }, {} );
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.
License
See LICENSE.
Copyright
Copyright © 2016-2021. The Stdlib Authors.