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

    0.0.8 • Public • Published

    Read-Only Accessor

    NPM version Build Status Coverage Status

    Define a read-only accessor.

    Installation

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

    Usage

    var setReadOnlyAccessor = require( '@stdlib/utils-define-read-only-accessor' );

    setReadOnlyAccessor( obj, prop, getter )

    Defines a read-only accessor.

    function getter() {
        return 'bar';
    }
    
    var obj = {};
    
    setReadOnlyAccessor( obj, 'foo', getter );
    
    obj.foo = 'boop';
    // throws <Error>

    Notes

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

    Examples

    var setReadOnlyAccessor = require( '@stdlib/utils-define-read-only-accessor' );
    
    function Foo( name ) {
        if ( !(this instanceof Foo) ) {
            return new Foo( name );
        }
        setReadOnlyAccessor( this, 'name', getName );
        return this;
    
        function getName() {
            return name;
        }
    }
    
    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


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2022. The Stdlib Authors.

    Install

    npm i @stdlib/utils-define-read-only-accessor

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    2,118

    Version

    0.0.8

    License

    Apache-2.0

    Unpacked Size

    38.6 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser