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

    0.0.5 • Public • Published

    hasProperty

    NPM version Build Status Coverage Status dependencies

    Test if an object has a specified property, either own or inherited.

    Installation

    npm install @stdlib/assert-has-property

    Usage

    var hasProp = require( '@stdlib/assert-has-property' );

    hasProp( value, property )

    Returns a boolean indicating if a value has a specified property, either own or inherited.

    var value = {
        'beep': 'boop'
    };
    
    var bool = hasProp( value, 'beep' );
    // returns true
    
    bool = hasProp( value, 'hasOwnProperty' );
    // returns true
    
    bool = hasProp( value, 'bap' );
    // returns false

    Notes

    • The function does not throw when provided null or undefined. Instead, the function returns false.

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

      var bool = hasProp( 'beep', 'length' );
      // returns true
    • Non-symbol property arguments are coerced to strings.

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

    Examples

    var hasProp = require( '@stdlib/assert-has-property' );
    
    var bool = hasProp( { 'a': 'b' }, 'a' );
    // returns true
    
    bool = hasProp( {}, 'hasOwnProperty' );
    // returns true
    
    bool = hasProp( { 'a': 'b' }, 'c' );
    // returns false
    
    bool = hasProp( { 'a': 'b' }, null );
    // returns false
    
    bool = hasProp( null, 'a' );
    // returns false
    
    bool = hasProp( void 0, 'a' );
    // returns false
    
    bool = hasProp( { 'null': false }, null );
    // returns true
    
    bool = hasProp( { '[object Object]': false }, {} );
    // returns true

    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-2021. The Stdlib Authors.

    Install

    npm i @stdlib/assert-has-property

    DownloadsWeekly Downloads

    45

    Version

    0.0.5

    License

    Apache-2.0

    Unpacked Size

    36.4 kB

    Total Files

    10

    Homepage

    stdlib.io

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar