Utils for working with JavaScript classes and prototype methods.
npm install class-utils> Utils for working with JavaScript classes and prototype methods.
Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.
Install with npm:
``sh`
$ npm install --save class-utils
`js`
var cu = require('class-utils');
Returns true if an array has any of the given elements, or an object has any of the give keys.
Params
* obj {Object}val
* {String|Array}returns
* {Boolean}
Example
`js
cu.has(['a', 'b', 'c'], 'c');
//=> true
cu.has(['a', 'b', 'c'], ['c', 'z']);
//=> true
cu.has({a: 'b', c: 'd'}, ['c', 'z']);
//=> true
`
Returns true if an array or object has all of the given values.
Params
* val {Object|Array}values
* {String|Array}returns
* {Boolean}
Example
`js
cu.hasAll(['a', 'b', 'c'], 'c');
//=> true
cu.hasAll(['a', 'b', 'c'], ['c', 'z']);
//=> false
cu.hasAll({a: 'b', c: 'd'}, ['c', 'z']);
//=> false
`
Cast the given value to an array.
Params
* val {String|Array}returns
* {Array}
Example
`js
cu.arrayify('foo');
//=> ['foo']
cu.arrayify(['foo']);
//=> ['foo']
`
Returns true if a value has a contructor
Params
* value {Object}returns
* {Boolean}
Example
`js
cu.hasConstructor({});
//=> true
cu.hasConstructor(Object.create(null));
//=> false
`
Get the native ownPropertyNames from the constructor of the given object. An empty array is returned if the object does not have a constructor.
Params
* obj {Object}: Object that has a constructor.returns
* {Array}: Array of keys.
Example
`js
cu.nativeKeys({a: 'b', b: 'c', c: 'd'})
//=> ['a', 'b', 'c']
cu.nativeKeys(function(){})
//=> ['length', 'caller']
`
Returns property descriptor key if it's an "own" property of the given object.
Params
* obj {Object}key
* {String}returns
* {Object}: Returns descriptor key
Example
`js`
function App() {}
Object.defineProperty(App.prototype, 'count', {
get: function() {
return Object.keys(this).length;
}
});
cu.getDescriptor(App.prototype, 'count');
// returns:
// {
// get: [Function],
// set: undefined,
// enumerable: false,
// configurable: false
// }
Copy a descriptor from one object to another.
Params
* receiver {Object}provider
* {Object}name
* {String}returns
* {Object}
Example
`js`
function App() {}
Object.defineProperty(App.prototype, 'count', {
get: function() {
return Object.keys(this).length;
}
});
var obj = {};
cu.copyDescriptor(obj, App.prototype, 'count');
Copy static properties, prototype properties, and descriptors
from one object to another.
Params
* receiver {Object}provider
* {Object}omit
* {String|Array}: One or more properties to omitreturns
* {Object}
Inherit the static properties, prototype properties, and descriptors
from of an object.
Params
* receiver {Object}provider
* {Object}omit
* {String|Array}: One or more properties to omitreturns
* {Object}
Returns a function for extending the static properties, prototype properties, and descriptors from the Parent constructor onto Child constructors.
Params
* Parent {Function}: Parent ctorextend
* {Function}: Optional extend function to handle custom extensions. Useful when updating methods that require a specific prototype.Child
* {Function}: Child ctorproto
* {Object}: Optionally pass additional prototype properties to inherit.returns
* {Object}
Example
`js
var extend = cu.extend(Parent);
Parent.extend(Child);
// optional methods
Parent.extend(Child, {
foo: function() {},
bar: function() {}
});
`
Bubble up events emitted from static methods on the Parent ctor.
Params
* Parent {Object}events
* {Array}: Event names to bubble up
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
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:
`sh`
$ npm install && npm test
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:
`sh``
$ npm install -g verbose/verb#dev verb-generate-readme && verb
You might also be interested in these projects:
* define-property: Define a non-enumerable property on an object. Uses Reflect.defineProperty when available, otherwise Object.defineProperty. | homepage
* delegate-properties: Deep-clone properties from one object to another and make them non-enumerable, or make existing properties… more | homepage
* is-descriptor: Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for… more | homepage
| Commits | Contributor |
| --- | --- |
| 34 | jonschlinkert |
| 8 | doowb |
| 2 | wtgtybhertgeghgtwtg |
Jon Schlinkert
* linkedin/in/jonschlinkert
* github/jonschlinkert
* twitter/jonschlinkert
Copyright © 2018, Jon Schlinkert.
Released under the MIT License.
*
_This file was generated by verb-generate-readme, v0.6.0, on January 11, 2018._