@stdlib/assert-is-enumerable-property
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    isEnumerableProperty

    NPM version Build Status Coverage Status

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

    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.

    Install

    npm i @stdlib/assert-is-enumerable-property

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    17,504

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    42.3 kB

    Total Files

    11

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser