@stdlib/utils-define-nonenumerable-read-only-property
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    Non-Enumerable Read-Only

    NPM version Build Status Coverage Status

    Define a non-enumerable read-only property.

    Installation

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

    Usage

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

    setNonEnumerableReadOnly( obj, prop, value )

    Defines a non-enumerable read-only property.

    var obj = {};
    
    setNonEnumerableReadOnly( obj, 'foo', 'bar' );
    
    obj.foo = 'boop';
    // throws <Error>

    Notes

    • Non-enumerable read-only properties are non-configurable.

    Examples

    var setNonEnumerableReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
    
    function Foo( name ) {
        if ( !(this instanceof Foo) ) {
            return new Foo( name );
        }
        setNonEnumerableReadOnly( this, 'name', name );
        return this;
    }
    
    var foo = new Foo( 'beep' );
    
    try {
        foo.name = 'boop';
    } catch ( err ) {
        console.error( err.message );
    }

    See Also


    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


    Copyright

    Copyright © 2016-2022. The Stdlib Authors.

    Install

    npm i @stdlib/utils-define-nonenumerable-read-only-property

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    165,743

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    38.9 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser