Read-Only

Define a 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 );
}