diff options
Diffstat (limited to 'node_modules/class-utils/README.md')
| -rw-r--r-- | node_modules/class-utils/README.md | 77 |
1 files changed, 45 insertions, 32 deletions
diff --git a/node_modules/class-utils/README.md b/node_modules/class-utils/README.md index 9b9966ec2..b49332efd 100644 --- a/node_modules/class-utils/README.md +++ b/node_modules/class-utils/README.md @@ -1,7 +1,9 @@ -# class-utils [](https://www.npmjs.com/package/class-utils) [](https://npmjs.org/package/class-utils) [](https://npmjs.org/package/class-utils) [](https://travis-ci.org/jonschlinkert/class-utils) +# class-utils [](https://www.npmjs.com/package/class-utils) [](https://npmjs.org/package/class-utils) [](https://npmjs.org/package/class-utils) [](https://travis-ci.org/jonschlinkert/class-utils) > Utils for working with JavaScript classes and prototype methods. +Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support. + ## Install Install with [npm](https://www.npmjs.com/): @@ -18,7 +20,7 @@ var cu = require('class-utils'); ## API -### [.has](index.js#L40) +### [.has](index.js#L43) Returns true if an array has any of the given elements, or an object has any of the give keys. @@ -41,7 +43,7 @@ cu.has({a: 'b', c: 'd'}, ['c', 'z']); //=> true ``` -### [.hasAll](index.js#L87) +### [.hasAll](index.js#L90) Returns true if an array or object has all of the given values. @@ -64,7 +66,7 @@ cu.hasAll({a: 'b', c: 'd'}, ['c', 'z']); //=> false ``` -### [.arrayify](index.js#L114) +### [.arrayify](index.js#L117) Cast the given value to an array. @@ -83,7 +85,7 @@ cu.arrayify(['foo']); //=> ['foo'] ``` -### [.hasConstructor](index.js#L149) +### [.hasConstructor](index.js#L152) Returns true if a value has a `contructor` @@ -102,7 +104,7 @@ cu.hasConstructor(Object.create(null)); //=> false ``` -### [.nativeKeys](index.js#L171) +### [.nativeKeys](index.js#L174) Get the native `ownPropertyNames` from the constructor of the given `object`. An empty array is returned if the object does not have a constructor. @@ -121,7 +123,7 @@ cu.nativeKeys(function(){}) //=> ['length', 'caller'] ``` -### [.getDescriptor](index.js#L203) +### [.getDescriptor](index.js#L208) Returns property descriptor `key` if it's an "own" property of the given object. @@ -150,7 +152,7 @@ cu.getDescriptor(App.prototype, 'count'); // } ``` -### [.copyDescriptor](index.js#L233) +### [.copyDescriptor](index.js#L238) Copy a descriptor from one object to another. @@ -174,7 +176,7 @@ var obj = {}; cu.copyDescriptor(obj, App.prototype, 'count'); ``` -### [.copy](index.js#L259) +### [.copy](index.js#L264) Copy static properties, prototype properties, and descriptors from one object to another. @@ -186,7 +188,7 @@ from one object to another. * `omit` **{String|Array}**: One or more properties to omit * `returns` **{Object}** -### [.inherit](index.js#L294) +### [.inherit](index.js#L299) Inherit the static properties, prototype properties, and descriptors from of an object. @@ -198,7 +200,7 @@ from of an object. * `omit` **{String|Array}**: One or more properties to omit * `returns` **{Object}** -### [.extend](index.js#L338) +### [.extend](index.js#L343) Returns a function for extending the static properties, prototype properties, and descriptors from the `Parent` constructor onto `Child` constructors. @@ -223,7 +225,7 @@ Parent.extend(Child, { }); ``` -### [.bubble](index.js#L351) +### [.bubble](index.js#L356) Bubble up events emitted from static methods on the Parent ctor. @@ -234,25 +236,25 @@ Bubble up events emitted from static methods on the Parent ctor. ## About -### Related projects +<details> +<summary><strong>Contributing</strong></summary> -* [define-property](https://www.npmjs.com/package/define-property): Define a non-enumerable property on an object. | [homepage](https://github.com/jonschlinkert/define-property) -* [delegate-properties](https://www.npmjs.com/package/delegate-properties): Deep-clone properties from one object to another and make them non-enumerable, or make existing properties… [more](https://github.com/jonschlinkert/delegate-properties) | [homepage](https://github.com/jonschlinkert/delegate-properties) -* [is-descriptor](https://www.npmjs.com/package/is-descriptor): Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for… [more](https://github.com/jonschlinkert/is-descriptor) | [homepage](https://github.com/jonschlinkert/is-descriptor) +Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). -### Contributing +</details> -Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). +<details> +<summary><strong>Running Tests</strong></summary> -### Contributors +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: -| **Commits** | **Contributor** | -| --- | --- | -| 32 | [jonschlinkert](https://github.com/jonschlinkert) | -| 8 | [doowb](https://github.com/doowb) | -| 2 | [wtgtybhertgeghgtwtg](https://github.com/wtgtybhertgeghgtwtg) | +```sh +$ npm install && npm test +``` -### Building docs +</details> +<details> +<summary><strong>Building docs</strong></summary> _(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.)_ @@ -262,26 +264,37 @@ To generate the readme, run the following command: $ npm install -g verbose/verb#dev verb-generate-readme && verb ``` -### Running tests +</details> -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: +### Related projects -```sh -$ npm install && npm test -``` +You might also be interested in these projects: + +* [define-property](https://www.npmjs.com/package/define-property): Define a non-enumerable property on an object. Uses Reflect.defineProperty when available, otherwise Object.defineProperty. | [homepage](https://github.com/jonschlinkert/define-property "Define a non-enumerable property on an object. Uses Reflect.defineProperty when available, otherwise Object.defineProperty.") +* [delegate-properties](https://www.npmjs.com/package/delegate-properties): Deep-clone properties from one object to another and make them non-enumerable, or make existing properties… [more](https://github.com/jonschlinkert/delegate-properties) | [homepage](https://github.com/jonschlinkert/delegate-properties "Deep-clone properties from one object to another and make them non-enumerable, or make existing properties on an object non-enumerable.") +* [is-descriptor](https://www.npmjs.com/package/is-descriptor): Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for… [more](https://github.com/jonschlinkert/is-descriptor) | [homepage](https://github.com/jonschlinkert/is-descriptor "Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for data descriptors and accessor descriptors.") + +### Contributors + +| **Commits** | **Contributor** | +| --- | --- | +| 34 | [jonschlinkert](https://github.com/jonschlinkert) | +| 8 | [doowb](https://github.com/doowb) | +| 2 | [wtgtybhertgeghgtwtg](https://github.com/wtgtybhertgeghgtwtg) | ### Author **Jon Schlinkert** +* [linkedin/in/jonschlinkert](https://linkedin.com/in/jonschlinkert) * [github/jonschlinkert](https://github.com/jonschlinkert) * [twitter/jonschlinkert](https://twitter.com/jonschlinkert) ### License -Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert). +Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert). Released under the [MIT License](LICENSE). *** -_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.2, on February 25, 2017._
\ No newline at end of file +_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on January 11, 2018._
\ No newline at end of file |