node_modules/extglob/node_modules/define-property/README.md

In thisisnic/starrating: What the Package Does (One Line, Title Case)

define-property

Define a non-enumerable property on an object.

Install

Install with npm:

$ npm install --save define-property

Install with yarn:

$ yarn add define-property

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.

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

define(obj, 'foo', {
  get: function() {},
  set: function() {}
});

About

Related projects

• assign-deep: Deeply assign the enumerable properties and/or es6 Symbol properies of source objects to the target… more | homepage
• extend-shallow: Extend an object with the properties of additional objects. node.js/javascript util. | homepage
• merge-deep: Recursively merge values in a javascript object. | homepage
• mixin-deep: Deeply mix the properties of objects into the first object. Like merge-deep, but doesn't clone. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

(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

Running tests

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

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.5.0, on April 20, 2017.

thisisnic/starrating documentation built on May 18, 2019, 1:32 p.m.