time-to-botec/js/node_modules/@stdlib/assert/has-property/README.md
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

2.7 KiB

hasProperty

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

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