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

isConfigurableProperty

Test if an object's own property is configurable.

Usage

var isConfigurableProperty = require( '@stdlib/assert/is-configurable-property' );

isConfigurableProperty( value, property )

Returns a boolean indicating if a value has a configurable property (i.e., a property which may be deleted or whose descriptor may be changed).

var defineProperty = require( '@stdlib/utils/define-property' );

var obj = {
    'foo': 'bar'
};

defineProperty( obj, 'beep', {
    'configurable': true,
    'enumerable': true,
    'writable': true,
    'value': true
});

defineProperty( obj, 'boop', {
    'configurable': false,
    'enumerable': true,
    'writable': true,
    'value': true
});

var bool = isConfigurableProperty( obj, 'foo' );
// returns true

bool = isConfigurableProperty( obj, 'beep' );
// returns true

bool = isConfigurableProperty( obj, 'boop' );
// returns false

Notes

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

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

• Property arguments are coerced to strings.

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

Examples

var isConfigurableProperty = require( '@stdlib/assert/is-configurable-property' );

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

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

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

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

bool = isConfigurableProperty( [ 'a' ], 'length' );
// returns false

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

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

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

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