<summary> About stdlib... </summary>

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

isEnumerableProperty

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]

Test if an object's own property is enumerable.

## Installation

bash
npm install @stdlib/assert-is-enumerable-property

## Usage

javascript
var isEnumerableProperty = require( '@stdlib/assert-is-enumerable-property' );

#### isEnumerableProperty( value, property ) Returns a boolean indicating if a value has an enumerable property.

javascript
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][mdn-object-property-is-enumerable], this function does not throw when provided null or undefined. Instead, the function returns false.

javascript
    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.

javascript
    var bool = isEnumerableProperty( 'beep', '1' );
    // returns true

- Property arguments are coerced to strings.

javascript
    var value = {
        'null': false
    };
    var bool = isEnumerableProperty( value, null );
    // returns true

    value = {
        '[object Object]': false
    };
    bool = isEnumerableProperty( value, {} );
    // returns true

## Examples

javascript
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][@stdlib/assert/is-configurable-property]: test if an object's own property is configurable. - [@stdlib/assert-is-enumerable-property-in][@stdlib/assert/is-enumerable-property-in]: test if an object's own or inherited property is enumerable. - [@stdlib/assert-is-nonenumerable-property][@stdlib/assert/is-nonenumerable-property]: test if an object's own property is non-enumerable. - [@stdlib/assert-is-readable-property][@stdlib/assert/is-readable-property]: test if an object's own property is readable. - [@stdlib/assert-is-writable-property][@stdlib/assert/is-writable-property]: test if an object's own property is writable.

* ## Notice This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].

Package detail

readme

isEnumerableProperty