Test if an object's own property is readable and writable.
npm install @stdlib/assert-is-read-write-propertyAlternatively,
- To load the package in a website via a
scripttag without installation and bundlers, use the ES Module available on theesmbranch. - If you are using Deno, visit the
denobranch. - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umdbranch.
The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
var isReadWriteProperty = require( '@stdlib/assert-is-read-write-property' );Returns a boolean indicating if a value has a readable and writable property.
var defineProperty = require( '@stdlib/utils-define-property' ); var obj = { 'foo': 'bar' }; defineProperty( obj, 'beep', { 'configurable': false, 'enumerable': false, 'writable': true, 'value': 'boop' }); defineProperty( obj, 'accessor', { 'configurable': false, 'enumerable': false, 'get': function getter() { return obj.foo; }, 'set': function setter( v ) { obj.foo = v; } }); var bool = isReadWriteProperty( obj, 'foo' ); // returns true bool = isReadWriteProperty( obj, 'beep' ); // returns true bool = isReadWriteProperty( obj, 'accessor' ); // returns true-
Value arguments other than
nullorundefinedare coerced toobjects.var bool = isReadWriteProperty( 'beep', 'length' ); // returns false
-
Property arguments are coerced to
strings.var obj = { 'null': 'foo' }; var bool = isReadWriteProperty( obj, null ); // returns true
var isReadWriteProperty = require( '@stdlib/assert-is-read-write-property' ); var bool = isReadWriteProperty( [ 'a' ], 'length' ); // returns true bool = isReadWriteProperty( { 'a': 'b' }, 'a' ); // returns true bool = isReadWriteProperty( [ 'a' ], 0 ); // returns true bool = isReadWriteProperty( { 'null': false }, null ); // returns true bool = isReadWriteProperty( { '[object Object]': false }, {} ); // returns true bool = isReadWriteProperty( {}, 'toString' ); // returns false bool = isReadWriteProperty( {}, 'hasOwnProperty' ); // returns false bool = isReadWriteProperty( null, 'a' ); // returns false bool = isReadWriteProperty( void 0, 'a' ); // returns false@stdlib/assert-is-read-only-property: test if an object's own property is read-only.@stdlib/assert-is-read-write-property-in: test if an object's own and inherited property is readable and writable.@stdlib/assert-is-readable-property: test if an object's own property is readable.@stdlib/assert-is-writable-property: test if an object's own property is writable.
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.
See LICENSE.
Copyright © 2016-2023. The Stdlib Authors.
