@ryniaubenpm/quod-ducimus-magni
v1.0.0
Published
<!--
Downloads
3
Maintainers
Keywords
Readme
Define Property
Define (or modify) an object property.
Installation
npm install @ryniaubenpm/quod-ducimus-magni
Alternatively,
- To load the package in a website via a
script
tag without installation and bundlers, use the ES Module available on theesm
branch (see README). - If you are using Deno, visit the
deno
branch (see README for usage intructions). - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umd
branch (see README).
The branches.md 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
var defineProperty = require( '@ryniaubenpm/quod-ducimus-magni' );
defineProperty( obj, prop, descriptor )
Defines (or modifies) an object property.
var obj = {};
defineProperty( obj, 'foo', {
'value': 'bar',
'writable': false
});
obj.foo = 'boop';
// throws <Error>
A property descriptor
has the following optional properties:
- configurable:
boolean
indicating if property descriptor can be changed and if the property can be deleted from the provided object. Default:false
. - enumerable:
boolean
indicating if the property shows up when enumerating object properties. Default:false
. - writable:
boolean
indicating if the value associated with the property can be changed with an assignment operator. Default:false
. - value: property value.
- get:
function
which serves as a getter for the property, or, if no getter,undefined
. When the property is accessed, a getter function is called without arguments and with thethis
context set to the object through which the property is accessed (which may not be the object on which the property is defined due to inheritance). The return value will be used as the property value. Default:undefined
. - set:
function
which serves as a setter for the property, or, if no setter,undefined
. When assigning a property value, a setter function is called with one argument (the value being assigned to the property) and with thethis
context set to the object through which the property is assigned. Default:undefined
.
Notes
- Property descriptors come in two flavors: data descriptors and accessor descriptors. A data descriptor is a property that has a value, which may or may not be writable. An accessor descriptor is a property described by a getter-setter function pair. A descriptor must be one of these two flavors and cannot be both.
Examples
var defineProperty = require( '@ryniaubenpm/quod-ducimus-magni' );
function Foo( name ) {
if ( !(this instanceof Foo) ) {
return new Foo( name );
}
defineProperty( this, 'name', {
'value': name,
'configurable': true
});
return this;
}
var foo = new Foo( 'beep' );
try {
delete foo.name;
console.log( '`name` property successfully deleted.' );
} catch ( err ) {
console.error( err.message );
}
See Also
@stdlib/utils-define-properties
: define (and/or modify) object properties.@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.