time-to-botec/js/node_modules/@stdlib/assert/is-accessor-property/README.md
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

3.2 KiB

isAccessorProperty

Test if an object's own property has an accessor descriptor.

Usage

var isAccessorProperty = require( '@stdlib/assert/is-accessor-property' );

isAccessorProperty( value, property )

Returns a boolean indicating if an object's own property has an accessor descriptor.

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

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

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

defineProperty( obj, 'accessor', {
    'configurable': false,
    'enumerable': false,
    'get': function getter() {
        return obj.foo;
    },
    'set': function setter( v ) {
        obj.foo = v;
    }
});

var bool = isAccessorProperty( obj, 'foo' );
// returns false

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

bool = isAccessorProperty( obj, 'accessor' );
// returns true

Notes

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

    var bool = isAccessorProperty( 'beep', 'length' );
    // returns false
    
  • Non-symbol property arguments are coerced to strings.

    var defineProperty = require( '@stdlib/utils/define-property' );
    
    var obj = {};
    
    function getter() {
        return true;
    }
    
    defineProperty( obj, 'null', {
        'configurable': true,
        'enumerable': true,
        'get': getter
    });
    
    var bool = isAccessorProperty( obj, null );
    // returns true
    

Examples

var isAccessorProperty = require( '@stdlib/assert/is-accessor-property' );

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

bool = isAccessorProperty( { 'a': 'b' }, 'a' );
// returns false

bool = isAccessorProperty( [ 'a' ], 0 );
// returns false

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

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

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

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

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

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