@stdlib/assert-has-property
v0.2.2
Published
Test if an object has a specified property, either own or inherited.
Downloads
729
Readme
hasProperty
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
orundefined
. Instead, the function returnsfalse
.var bool = hasProp( null, 'a' ); // returns false bool = hasProp( void 0, 'a' ); // returns false
Value arguments other than
null
orundefined
are coerced toobjects
.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
See Also
@stdlib/assert-has-own-property
: test if an object has a specified property.
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
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.