@stdlib/assert-is-readable-property
v0.2.2
Published
Test if an object's own property is readable.
Downloads
5
Readme
isReadableProperty
Test if an object's own property is readable.
Installation
npm install @stdlib/assert-is-readable-property
Usage
var isReadableProperty = require( '@stdlib/assert-is-readable-property' );
isReadableProperty( value, property )
Returns a boolean
indicating if a value
has a readable property
.
var defineProperty = require( '@stdlib/utils-define-property' );
var obj = {
'foo': 'bar'
};
defineProperty( obj, 'beep', {
'configurable': false,
'enumerable': false,
'writable': false,
'value': 'boop'
});
defineProperty( obj, 'setter', {
'configurable': false,
'enumerable': false,
'set': function setter( v ) {
obj.foo = v;
}
});
var bool = isReadableProperty( obj, 'foo' );
// returns true
bool = isReadableProperty( obj, 'beep' );
// returns true
bool = isReadableProperty( obj, 'setter' );
// returns false
Notes
Value arguments other than
null
orundefined
are coerced toobjects
.var bool = isReadableProperty( 'beep', 'length' ); // returns true
Property arguments are coerced to
strings
.var obj = { 'null': 'foo' }; var bool = isReadableProperty( obj, null ); // returns true
Examples
var isReadableProperty = require( '@stdlib/assert-is-readable-property' );
var bool = isReadableProperty( [ 'a' ], 'length' );
// returns true
bool = isReadableProperty( { 'a': 'b' }, 'a' );
// returns true
bool = isReadableProperty( [ 'a' ], 0 );
// returns true
bool = isReadableProperty( { 'null': false }, null );
// returns true
bool = isReadableProperty( { '[object Object]': false }, {} );
// returns true
bool = isReadableProperty( {}, 'toString' );
// returns false
bool = isReadableProperty( {}, 'hasOwnProperty' );
// returns false
bool = isReadableProperty( null, 'a' );
// returns false
bool = isReadableProperty( void 0, 'a' );
// returns false
See Also
@stdlib/assert-is-read-only-property
: test if an object's own property is read-only.@stdlib/assert-is-read-write-property
: test if an object's own property is readable and writable.@stdlib/assert-is-readable-property-in
: test if an object's own or inherited property is readable.@stdlib/assert-is-writable-property
: test if an object's own property is writable.
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.