https://github.com/stdlib-js/utils-define-configurable-read-only-accessor
Define a configurable read-only accessor.
https://github.com/stdlib-js/utils-define-configurable-read-only-accessor
accessor configurable define enumerable get getter javascript node node-js nodejs object prop property read-only stdlib util utilities utility utils writable
Last synced: about 2 months ago
JSON representation
Define a configurable read-only accessor.
- Host: GitHub
- URL: https://github.com/stdlib-js/utils-define-configurable-read-only-accessor
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-04T17:42:39.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-10T01:54:07.000Z (3 months ago)
- Last Synced: 2025-03-27T01:46:46.581Z (2 months ago)
- Topics: accessor, configurable, define, enumerable, get, getter, javascript, node, node-js, nodejs, object, prop, property, read-only, stdlib, util, utilities, utility, utils, writable
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 433 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
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!
# Configurable Read-Only Accessor
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> [Define][@stdlib/utils/define-property] a configurable **read-only** accessor.
## Installation
```bash
npm install @stdlib/utils-define-configurable-read-only-accessor
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var setConfigurableReadOnlyAccessor = require( '@stdlib/utils-define-configurable-read-only-accessor' );
```
#### setConfigurableReadOnlyAccessor( obj, prop, getter )
[Defines][@stdlib/utils/define-property] a configurable **read-only** accessor.
```javascript
function getter() {
return 'bar';
}
var obj = {};
setConfigurableReadOnlyAccessor( obj, 'foo', getter );
obj.foo = 'boop';
// throws
```
## Notes
- Configurable read-only accessors are **enumerable**.
## Examples
```javascript
var setConfigurableReadOnlyAccessor = require( '@stdlib/utils-define-configurable-read-only-accessor' );
function Foo( name ) {
if ( !(this instanceof Foo) ) {
return new Foo( name );
}
setConfigurableReadOnlyAccessor( 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
- [`@stdlib/utils-define-configurable-read-only-property`][@stdlib/utils/define-configurable-read-only-property]: define a configurable read-only property.
- [`@stdlib/utils-define-configurable-read-write-accessor`][@stdlib/utils/define-configurable-read-write-accessor]: define a configurable read-write accessor.
- [`@stdlib/utils-define-configurable-write-only-accessor`][@stdlib/utils/define-configurable-write-only-accessor]: define a configurable write-only accessor.
- [`@stdlib/utils-define-property`][@stdlib/utils/define-property]: define (or modify) an object property.
- [`@stdlib/utils-define-read-only-accessor`][@stdlib/utils/define-read-only-accessor]: define a read-only accessor.
* * *
## Notice
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/utils-define-configurable-read-only-accessor.svg
[npm-url]: https://npmjs.org/package/@stdlib/utils-define-configurable-read-only-accessor
[test-image]: https://github.com/stdlib-js/utils-define-configurable-read-only-accessor/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/utils-define-configurable-read-only-accessor/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-define-configurable-read-only-accessor/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/utils-define-configurable-read-only-accessor?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/utils-define-configurable-read-only-accessor/tree/deno
[deno-readme]: https://github.com/stdlib-js/utils-define-configurable-read-only-accessor/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/utils-define-configurable-read-only-accessor/tree/umd
[umd-readme]: https://github.com/stdlib-js/utils-define-configurable-read-only-accessor/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/utils-define-configurable-read-only-accessor/tree/esm
[esm-readme]: https://github.com/stdlib-js/utils-define-configurable-read-only-accessor/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/utils-define-configurable-read-only-accessor/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-define-configurable-read-only-accessor/main/LICENSE
[@stdlib/utils/define-configurable-read-only-property]: https://github.com/stdlib-js/utils-define-configurable-read-only-property
[@stdlib/utils/define-configurable-read-write-accessor]: https://github.com/stdlib-js/utils-define-configurable-read-write-accessor
[@stdlib/utils/define-configurable-write-only-accessor]: https://github.com/stdlib-js/utils-define-configurable-write-only-accessor
[@stdlib/utils/define-property]: https://github.com/stdlib-js/utils-define-property
[@stdlib/utils/define-read-only-accessor]: https://github.com/stdlib-js/utils-define-read-only-accessor