@stdlib/utils-define-read-write-accessor

Define a read-write accessor.

Usage no npm install needed!

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

README

Read-Write Accessor

NPM version Build Status Coverage Status

Define a read-write accessor.

Installation

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

Usage

var setReadWriteAccessor = require( '@stdlib/utils-define-read-write-accessor' );

setReadWriteAccessor( obj, prop, getter, setter )

Defines a read-write accessor.

var word = 'bar';
var obj = {};

function getter() {
    return word + ' foo';
}

function setter( v ) {
    word = v;
}

setReadWriteAccessor( obj, 'foo', getter, setter );

var v = obj.foo;
// returns 'bar foo'

obj.foo = 'beep';

v = obj.foo;
// returns 'beep foo'

Notes

  • Read-write accessors are enumerable and non-configurable.

Examples

var setReadWriteAccessor = require( '@stdlib/utils-define-read-write-accessor' );

function Foo( name ) {
    if ( !(this instanceof Foo) ) {
        return new Foo( name );
    }
    setReadWriteAccessor( this, 'name', getName, setName );
    return this;

    function getName() {
        return 'Hello, ' + name;
    }

    function setName( v ) {
        name = v;
    }
}

var foo = new Foo( 'Grace' );
console.log( foo.name );

foo.name = 'Ada';
console.log( foo.name );

See Also

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.