Configurable Read-Only Accessor

Define a configurable read-only accessor.

Installation

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

Usage

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

setConfigurableReadOnlyAccessor( obj, prop, getter )

Defines a configurable read-only accessor.

function getter() {
    return 'bar';
}

var obj = {};

setConfigurableReadOnlyAccessor( obj, 'foo', getter );

obj.foo = 'boop';
// throws <Error>

Notes

• Configurable read-only accessors are enumerable.

Examples

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

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

    function getName() {
        return name;
    }
}

var foo = new Foo( 'beep' );

try {
    foo.name = 'boop';
} catch ( err ) {
    console.error( err.message );
}

See Also

• @stdlib/utils-define-configurable-read-only-property: define a configurable read-only property.
• @stdlib/utils-define-configurable-read-write-accessor: define a configurable read-write accessor.
• @stdlib/utils-define-configurable-write-only-accessor: define a configurable write-only accessor.
• @stdlib/utils-define-property: define (or modify) an object property.
• @stdlib/utils-define-read-only-accessor: define a read-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.