JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 31174
  • Score
    100M100P100Q171132F
  • License Apache-2.0

Define a read-only property.

Package Exports

  • @stdlib/utils-define-read-only-property
  • @stdlib/utils-define-read-only-property/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/utils-define-read-only-property) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Read-Only

NPM version Build Status Coverage Status

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

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

Chat


License

See LICENSE.

Copyright © 2016-2022. The Stdlib Authors.