Write-Only Accessor

Define a write-only accessor.

Installation

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

Usage

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

setWriteOnlyAccessor( obj, prop, setter )

Defines a write-only accessor.

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

function setter( v ) {
    val = v;
}

setWriteOnlyAccessor( obj, 'foo', setter );

obj.foo = 'boop';

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

Notes

• Write-only accessors are enumerable and non-configurable.

Examples

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

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

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

var foo = new Foo( 'beep' );

foo.secret = 'boop';

See Also

• @stdlib/utils-define-read-only-property: define a read-only property.
• @stdlib/utils-define-read-only-accessor: define a read-only accessor.
• @stdlib/utils-define-read-write-accessor: define a read-write 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.