define-property
Advanced tools
Package description
The define-property npm package is used to define a new property directly on an object, or modify an existing property on an object, and return the object. It is a convenience wrapper around Object.defineProperty that allows you to easily set configurable, enumerable, and writable property attributes.
Define a new property with default attributes
This feature allows you to define a new property on an object with default attributes. The property will be configurable, enumerable, and writable.
{"object": {"foo": "bar"}, "propertyName": "newProp", "value": 123}Define a new property with custom attributes
This feature allows you to define a new property on an object with custom attributes, such as making the property non-writable.
{"object": {"foo": "bar"}, "propertyName": "newProp", "descriptor": {"value": 123, "configurable": true, "enumerable": true, "writable": false}}This package provides similar functionality to define-property by allowing you to define a new property on an object. It is a direct polyfill for Object.defineProperty, which can be useful for environments that do not support the ES5 method.
While not a direct alternative, property-expr allows you to work with property paths. It can compile strings into functions that can set properties on an object, which can be seen as a more dynamic way to define properties.
Readme
Define a non-enumerable property on an object. Uses Reflect.defineProperty when available, otherwise Object.defineProperty.
Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.
Install with npm:
$ npm install --save define-property
See the CHANGELOG for updates.
Params
object: The object on which to define the property.key: The name of the property to be defined or modified.value: The value or descriptor of the property being defined or modified.var define = require('define-property');
var obj = {};
define(obj, 'foo', function(val) {
return val.toUpperCase();
});
// by default, defined properties are non-enumberable
console.log(obj);
//=> {}
console.log(obj.foo('bar'));
//=> 'BAR'
defining setters/getters
Pass the same properties you would if using Object.defineProperty or Reflect.defineProperty.
define(obj, 'foo', {
set: function() {},
get: function() {}
});
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
You might also be interested in these projects:
| Commits | Contributor |
|---|---|
| 28 | jonschlinkert |
| 1 | doowb |
Jon Schlinkert
Copyright © 2018, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on January 25, 2018.
FAQs
Define a non-enumerable property on an object. Uses Reflect.defineProperty when available, otherwise Object.defineProperty.
The npm package define-property receives a total of 52,563,216 weekly downloads. As such, define-property popularity was classified as popular.
We found that define-property demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.