@stdlib/assert-is-enumerable-property
v0.2.2
Published
Test if an object's own property is enumerable.
Downloads
144,533
Readme
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' );
// returns true
bool = isEnumerableProperty( value, 'constructor' );
// returns false
Notes
In contrast to the native Object.prototype.propertyIsEnumerable, this function does not throw when provided
null
orundefined
. Instead, the function returnsfalse
.var bool = isEnumerableProperty( null, 'a' ); // returns false bool = isEnumerableProperty( void 0, 'a' ); // returns false
Value arguments other than
null
orundefined
are coerced toobjects
.var bool = isEnumerableProperty( 'beep', '1' ); // returns true
Property arguments are coerced to
strings
.var value = { 'null': false }; var bool = isEnumerableProperty( value, null ); // returns true value = { '[object Object]': false }; bool = isEnumerableProperty( value, {} ); // returns true
Examples
var isEnumerableProperty = require( '@stdlib/assert-is-enumerable-property' );
var bool = isEnumerableProperty( { 'a': 'b' }, 'a' );
// returns true
bool = isEnumerableProperty( [ 'a' ], 0 );
// returns true
bool = isEnumerableProperty( [ 'a' ], 'length' );
// returns false
bool = isEnumerableProperty( {}, 'toString' );
// returns false
bool = isEnumerableProperty( {}, 'hasOwnProperty' );
// returns false
bool = isEnumerableProperty( null, 'a' );
// returns false
bool = isEnumerableProperty( void 0, 'a' );
// returns false
bool = isEnumerableProperty( { 'null': false }, null );
// returns true
bool = isEnumerableProperty( { '[object Object]': false }, {} );
// returns true
See Also
@stdlib/assert-is-configurable-property
: test if an object's own property is configurable.@stdlib/assert-is-enumerable-property-in
: test if an object's own or inherited property is enumerable.@stdlib/assert-is-nonenumerable-property
: test if an object's own property is non-enumerable.@stdlib/assert-is-readable-property
: test if an object's own property is readable.@stdlib/assert-is-writable-property
: test if an object's own property is writable.
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-2024. The Stdlib Authors.