Configurable Read-Only

Define a configurable read-only property.

Installation

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

Usage

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

setConfigurableReadOnly( obj, prop, value )

Defines a configurable read-only property.

var obj = {};

setConfigurableReadOnly( obj, 'foo', 'bar' );

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

Notes

• Configurable read-only properties are enumerable.

Examples

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

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

var foo = new Foo( 'beep' );

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

See Also

• @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-read-only-property: define a read-only property.

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.