time-to-botec/js/node_modules/@stdlib/assert/is-writable-property/README.md

isWritableProperty

Test if an object's own property is writable.

Usage

var isWritableProperty = require( '@stdlib/assert/is-writable-property' );

isWritableProperty( value, property )

Returns a boolean indicating if a value has a writable 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 = isWritableProperty( obj, 'foo' );
// returns true

bool = isWritableProperty( obj, 'setter' );
// returns true

bool = isWritableProperty( obj, 'beep' );
// returns false

Notes

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

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

• Property arguments are coerced to strings.

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

Examples

var isWritableProperty = require( '@stdlib/assert/is-writable-property' );

var bool = isWritableProperty( [ 'a' ], 'length' );
// returns true

bool = isWritableProperty( { 'a': 'b' }, 'a' );
// returns true

bool = isWritableProperty( [ 'a' ], 0 );
// returns true

bool = isWritableProperty( { 'null': false }, null );
// returns true

bool = isWritableProperty( { '[object Object]': false }, {} );
// returns true

bool = isWritableProperty( {}, 'toString' );
// returns false

bool = isWritableProperty( {}, 'hasOwnProperty' );
// returns false

bool = isWritableProperty( null, 'a' );
// returns false

bool = isWritableProperty( void 0, 'a' );
// returns false