.config/coc/extensions/node_modules/coc-prettier/node_modules/base/node_modules/define-property/README.md

   1 # define-property [![NPM version](https://img.shields.io/npm/v/define-property.svg?style=flat)](https://www.npmjs.com/package/define-property) [![NPM monthly downloads](https://img.shields.io/npm/dm/define-property.svg?style=flat)](https://npmjs.org/package/define-property)  [![NPM total downloads](https://img.shields.io/npm/dt/define-property.svg?style=flat)](https://npmjs.org/package/define-property) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/define-property.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/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 install --save define-property
  11 ```
  12
  13 Install with [yarn](https://yarnpkg.com):
  14
  15 ```sh
  16 $ yarn add define-property
  17 ```
  18
  19 ## Usage
  20
  21 **Params**
  22
  23 * `obj`: The object on which to define the property.
  24 * `prop`: The name of the property to be defined or modified.
  25 * `descriptor`: The descriptor for the property being defined or modified.
  26
  27 ```js
  28 var define = require('define-property');
  29 var obj = {};
  30 define(obj, 'foo', function(val) {
  31   return val.toUpperCase();
  32 });
  33
  34 console.log(obj);
  35 //=> {}
  36
  37 console.log(obj.foo('bar'));
  38 //=> 'BAR'
  39 ```
  40
  41 **get/set**
  42
  43 ```js
  44 define(obj, 'foo', {
  45   get: function() {},
  46   set: function() {}
  47 });
  48 ```
  49
  50 ## About
  51
  52 ### Related projects
  53
  54 * [assign-deep](https://www.npmjs.com/package/assign-deep): Deeply assign the enumerable properties and/or es6 Symbol properies of source objects to the target… [more](https://github.com/jonschlinkert/assign-deep) | [homepage](https://github.com/jonschlinkert/assign-deep "Deeply assign the enumerable properties and/or es6 Symbol properies of source objects to the target (first) object.")
  55 * [extend-shallow](https://www.npmjs.com/package/extend-shallow): Extend an object with the properties of additional objects. node.js/javascript util. | [homepage](https://github.com/jonschlinkert/extend-shallow "Extend an object with the properties of additional objects. node.js/javascript util.")
  56 * [merge-deep](https://www.npmjs.com/package/merge-deep): Recursively merge values in a javascript object. | [homepage](https://github.com/jonschlinkert/merge-deep "Recursively merge values in a javascript object.")
  57 * [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 "Deeply mix the properties of objects into the first object. Like merge-deep, but doesn't clone.")
  58
  59 ### Contributing
  60
  61 Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
  62
  63 ### Building docs
  64
  65 _(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
  66
  67 To generate the readme, run the following command:
  68
  69 ```sh
  70 $ npm install -g verbose/verb#dev verb-generate-readme && verb
  71 ```
  72
  73 ### Running tests
  74
  75 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:
  76
  77 ```sh
  78 $ npm install && npm test
  79 ```
  80
  81 ### Author
  82
  83 **Jon Schlinkert**
  84
  85 * [github/jonschlinkert](https://github.com/jonschlinkert)
  86 * [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
  87
  88 ### License
  89
  90 Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
  91 Released under the [MIT License](LICENSE).
  92
  93 ***
  94
  95 _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.5.0, on April 20, 2017._