isWriteOnlyProperty

Test if an object's own property is write-only.

Usage

var isWriteOnlyProperty = require( '@stdlib/assert/is-write-only-property' );

isWriteOnlyProperty( value, property )

Returns a boolean indicating if a value has a write-only 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, 'accessor', {
    'configurable': false,
    'enumerable': true,
    'set': function setter( v ) {
        obj.foo = v;
    }
});

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

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

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

Notes

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

    var bool = isWriteOnlyProperty( 'beep', 'length' );
    // returns false
    
  • Property arguments are coerced to strings.

    var defineProperty = require( '@stdlib/utils/define-property' );
    
    var obj = {};
    
    function setter( v ) {
        obj.null = v;
    }
    
    defineProperty( obj, 'null', {
        'configurable': false,
        'enumerable': true,
        'set': setter
    });
    
    var bool = isWriteOnlyProperty( obj, null );
    // returns true
    

Examples

var isWriteOnlyProperty = require( '@stdlib/assert/is-write-only-property' );

var bool = isWriteOnlyProperty( 'a', 'length' );
// returns false

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

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

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

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

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

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

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

bool = isWriteOnlyProperty( void 0, 'a' );
// returns false
Did you find this page helpful?