class-utils ![NPM version](https://badge.fury.io/js/class-utils.svg)
Utils for working with JavaScript classes and prototype methods.
Install
Install with npm
$ npm i class-utils --save
Usage
var cu = require('class-utils');
API
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
cu.has(['a', 'b', 'c'], 'c');
cu.has(['a', 'b', 'c'], ['c', 'z']);
cu.has({a: 'b', c: 'd'}, ['c', 'z']);
Returns true if an array or object has all of the given values.
Params
val
{Object|Array}values
{String|Array}returns
{Boolean}
Example
cu.hasAll(['a', 'b', 'c'], 'c');
cu.hasAll(['a', 'b', 'c'], ['c', 'z']);
cu.hasAll({a: 'b', c: 'd'}, ['c', 'z']);
Cast the given value to an array.
Params
val
{String|Array}returns
{Array}
Example
cu.arrayify('foo');
cu.arrayify(['foo']);
Returns true if a value has a contructor
Params
value
{Object}returns
{Boolean}
Example
cu.hasConstructor({});
cu.hasConstructor(Object.create(null));
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
cu.nativeKeys({a: 'b', b: 'c', c: 'd'})
cu.nativeKeys(function(){})
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
function App() {}
Object.defineProperty(App.prototype, 'count', {
get: function() {
return Object.keys(this).length;
}
});
cu.getDescriptor(App.prototype, 'count');
Copy a descriptor from one object to another.
Params
receiver
{Object}provider
{Object}name
{String}returns
{Object}
Example
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 ctorChild
{Function}: Child ctorproto
{Object}: Optionally pass additional prototype properties to inherit.returns
{Object}
Example
var extend = cu.extend(Parent);
Parent.extend(Child);
Parent.extend(Child, {
foo: function() {},
bar: function() {}
});
Related projects
Running tests
Install dev dependencies:
$ npm i -d && npm test
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Author
Jon Schlinkert
License
Copyright © 2015 Jon Schlinkert
Released under the MIT license.
This file was generated by verb-cli on October 21, 2015.