.gitignore added
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-prettier / node_modules / object-copy / node_modules / define-property / README.md
1 # define-property [![NPM version](https://badge.fury.io/js/define-property.svg)](http://badge.fury.io/js/define-property)
2
3 > Define a non-enumerable property on an object.
4
5 ## Install
6
7 Install with [npm](https://www.npmjs.com/)
8
9 ```sh
10 $ npm i define-property --save
11 ```
12
13 ## Usage
14
15 **Params**
16
17 * `obj`: The object on which to define the property.
18 * `prop`: The name of the property to be defined or modified.
19 * `descriptor`: The descriptor for the property being defined or modified.
20
21 ```js
22 var define = require('define-property');
23 var obj = {};
24 define(obj, 'foo', function(val) {
25   return val.toUpperCase();
26 });
27
28 console.log(obj);
29 //=> {}
30
31 console.log(obj.foo('bar'));
32 //=> 'BAR'
33 ```
34
35 **get/set**
36
37 ```js
38 define(obj, 'foo', {
39   get: function() {},
40   set: function() {}
41 });
42 ```
43
44 ## Related projects
45
46 * [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)
47 * [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)
48 * [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)
49 * [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)
50
51 ## Running tests
52
53 Install dev dependencies:
54
55 ```sh
56 $ npm i -d && npm test
57 ```
58
59 ## Contributing
60
61 Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/define-property/issues/new).
62
63 ## Author
64
65 **Jon Schlinkert**
66
67 + [github/jonschlinkert](https://github.com/jonschlinkert)
68 + [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
69
70 ## License
71
72 Copyright © 2015 Jon Schlinkert
73 Released under the MIT license.
74
75 ***
76
77 _This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on August 31, 2015._