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

What is @stdlib/utils-define-nonenumerable-read-only-property?

@stdlib/utils-define-nonenumerable-read-only-property is a utility package that allows you to define non-enumerable, read-only properties on objects. This can be useful for creating properties that should not be iterated over in loops and should not be modified.

What are @stdlib/utils-define-nonenumerable-read-only-property's main functionalities?

Define Non-Enumerable Read-Only Property

This feature allows you to define a property on an object that is non-enumerable and read-only. The property will not show up in for-in loops and cannot be modified.

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

const obj = {};
defineNonEnumerableReadOnlyProperty(obj, 'foo', 'bar');

console.log(obj.foo); // 'bar'

for (const key in obj) {
  console.log(key); // This will not log 'foo'
}

obj.foo = 'baz';
console.log(obj.foo); // 'bar' (value is not changed)

Other packages similar to @stdlib/utils-define-nonenumerable-read-only-property

define-property

The 'define-property' package allows you to define properties on an object with specific descriptors, including non-enumerable and read-only. It is a lightweight utility that offers similar functionality to @stdlib/utils-define-nonenumerable-read-only-property but with a broader scope for defining different types of properties.

README

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Non-Enumerable Read-Only

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

• @stdlib/utils-define-nonenumerable-property: define a non-enumerable property.
• @stdlib/utils-define-nonenumerable-read-only-accessor: define a non-enumerable read-only accessor.
• @stdlib/utils-define-nonenumerable-read-write-accessor: define a non-enumerable read-write accessor.
• @stdlib/utils-define-nonenumerable-write-only-accessor: define a non-enumerable write-only accessor.
• @stdlib/utils-define-read-only-property: define a read-only property.

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

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Changelog

0.2.2 (2024-07-26)

No changes reported for this release.

</section> <!-- /.release --> <section class="release" id="v0.2.1">