isEnumerableProperty

Test if an object's own property is enumerable.

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 or undefined. Instead, the function returns false.

    var bool = isEnumerableProperty( null, 'a' ); // returns false bool = isEnumerableProperty( void 0, 'a' ); // returns false 
  • Value arguments other than null or undefined are coerced to objects.

    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