Read-Only

Define a read-only property.

Installation

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

Usage

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

setReadOnly( obj, prop, value )

Defines a read-only property.

var obj = {};

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

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

Notes

• Read-only properties are enumerable and non-configurable.

Examples

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

function Foo( name ) {
    if ( !(this instanceof Foo) ) {
        return new Foo( name );
    }
    setReadOnly( 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-read-only-accessor: define a read-only accessor.
• @stdlib/utils-define-read-write-accessor: define a read-write accessor.
• @stdlib/utils-define-write-only-accessor: define a write-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.