Skip to content

Latest commit

 

History

History

define-read-only-property

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

Read-Only

[Define][define-property] a read-only property.

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

setReadOnly( obj, prop, value )

[Defines][define-property] a read-only property.

var obj = {};
setReadOnly( obj, 'foo', 'bar' );
obj.foo = 'boop'; // => throws
## 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 );
}
[define-property]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/defineProperty