forked from projectmoon/tenebrous-dicebot
78 lines
2.4 KiB
Markdown
78 lines
2.4 KiB
Markdown
|
# define-property [](http://badge.fury.io/js/define-property)
|
||
|
|
|
||
|
|
> Define a non-enumerable property on an object.
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
Install with [npm](https://www.npmjs.com/)
|
||
|
|
|
||
|
|
```sh
|
||
|
|
$ npm i define-property --save
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
**Params**
|
||
|
|
|
||
|
|
* `obj`: The object on which to define the property.
|
||
|
|
* `prop`: The name of the property to be defined or modified.
|
||
|
|
* `descriptor`: The descriptor for the property being defined or modified.
|
||
|
|
|
||
|
|
```js
|
||
|
|
var define = require('define-property');
|
||
|
|
var obj = {};
|
||
|
|
define(obj, 'foo', function(val) {
|
||
|
|
return val.toUpperCase();
|
||
|
|
});
|
||
|
|
|
||
|
|
console.log(obj);
|
||
|
|
//=> {}
|
||
|
|
|
||
|
|
console.log(obj.foo('bar'));
|
||
|
|
//=> 'BAR'
|
||
|
|
```
|
||
|
|
|
||
|
|
**get/set**
|
||
|
|
|
||
|
|
```js
|
||
|
|
define(obj, 'foo', {
|
||
|
|
get: function() {},
|
||
|
|
set: function() {}
|
||
|
|
});
|
||
|
|
```
|
||
|
|
|
||
|
|
## Related projects
|
||
|
|
|
||
|
|
* [delegate-object](https://www.npmjs.com/package/delegate-object): Copy properties from an object to another object, where properties with function values will be… [more](https://www.npmjs.com/package/delegate-object) | [homepage](https://github.com/doowb/delegate-object)
|
||
|
|
* [forward-object](https://www.npmjs.com/package/forward-object): Copy properties from an object to another object, where properties with function values will be… [more](https://www.npmjs.com/package/forward-object) | [homepage](https://github.com/doowb/forward-object)
|
||
|
|
* [mixin-deep](https://www.npmjs.com/package/mixin-deep): Deeply mix the properties of objects into the first object. Like merge-deep, but doesn't clone. | [homepage](https://github.com/jonschlinkert/mixin-deep)
|
||
|
|
* [mixin-object](https://www.npmjs.com/package/mixin-object): Mixin the own and inherited properties of other objects onto the first object. Pass an… [more](https://www.npmjs.com/package/mixin-object) | [homepage](https://github.com/jonschlinkert/mixin-object)
|
||
|
|
|
||
|
|
## Running tests
|
||
|
|
|
||
|
|
Install dev dependencies:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
$ npm i -d && npm test
|
||
|
|
```
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/define-property/issues/new).
|
||
|
|
|
||
|
|
## Author
|
||
|
|
|
||
|
|
**Jon Schlinkert**
|
||
|
|
|
||
|
|
+ [github/jonschlinkert](https://github.com/jonschlinkert)
|
||
|
|
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
Copyright © 2015 Jon Schlinkert
|
||
|
|
Released under the MIT license.
|
||
|
|
|
||
|
|
***
|
||
|
|
|
||
|
|
_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on August 31, 2015._
|