time-to-botec/squiggle/node_modules/@stdlib/assert/is-read-write-property

isReadWriteProperty

Test if an object's own property is readable and writable.

Usage

var isReadWriteProperty = require( '@stdlib/assert/is-read-write-property' );

isReadWriteProperty( value, 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

Notes

• Value arguments other than null or undefined are coerced to objects.

  var bool = isReadWriteProperty( 'beep', 'length' );
  // returns false
  

• Property arguments are coerced to strings.

  var obj = {
      'null': 'foo'
  };
  
  var bool = isReadWriteProperty( obj, null );
  // returns true
  

Examples

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