@stdlib/utils-define-nonenumerable-write-only-accessor

Define a non-enumerable write-only accessor.

Usage no npm install needed!

<script type="module">
  import stdlibUtilsDefineNonenumerableWriteOnlyAccessor from 'https://cdn.skypack.dev/@stdlib/utils-define-nonenumerable-write-only-accessor';
</script>

README

Non-Enumerable Write-Only Accessor

NPM version Build Status Coverage Status

Define a non-enumerable write-only accessor.

Installation

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

Usage

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

setNonEnumerableWriteOnlyAccessor( obj, prop, setter )

Defines a non-enumerable write-only accessor.

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

function setter( v ) {
    val = v;
}

setNonEnumerableWriteOnlyAccessor( obj, 'foo', setter );

obj.foo = 'boop';

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

Notes

  • Non-enumerable write-only accessors are non-configurable.

Examples

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

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

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

var foo = new Foo( 'beep' );

foo.secret = 'boop';

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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2022. The Stdlib Authors.