Configurable Write-Only Accessor

Define a configurable write-only accessor.

Installation

npm install @stdlib/utils-define-configurable-write-only-accessor

Usage

var setConfigurableWriteOnlyAccessor = require( '@stdlib/utils-define-configurable-write-only-accessor' );

setConfigurableWriteOnlyAccessor( obj, prop, setter )

Defines a configurable write-only accessor.

var obj = {};
var val = '';

function setter( v ) {
    val = v;
}

setConfigurableWriteOnlyAccessor( obj, 'foo', setter );

obj.foo = 'boop';

var bool = ( val === 'boop' );
// returns true

Notes

• Configurable write-only accessors are enumerable.

Examples

var setConfigurableWriteOnlyAccessor = require( '@stdlib/utils-define-configurable-write-only-accessor' );

function Foo( secret ) {
    if ( !(this instanceof Foo) ) {
        return new Foo( secret );
    }
    setConfigurableWriteOnlyAccessor( this, 'secret', setter );
    return this;

    function setter( v ) {
        secret = v;
    }
}

var foo = new Foo( 'beep' );

foo.secret = 'boop';

See Also

• @stdlib/utils-define-configurable-read-only-property: define a configurable read-only property.
• @stdlib/utils-define-configurable-read-only-accessor: define a configurable read-only accessor.
• @stdlib/utils-define-configurable-read-write-accessor: define a configurable read-write accessor.
• @stdlib/utils-define-property: define (or modify) an object property.
• @stdlib/utils-define-write-only-accessor: define a write-only accessor.

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.