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

Install with npm:

1$ npm install --save class-utils

Usage

1var cu = require('class-utils');

API

.has

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

1cu.has(['a', 'b', 'c'], 'c');
2//=> true
3
4cu.has(['a', 'b', 'c'], ['c', 'z']);
5//=> true
6
7cu.has({a: 'b', c: 'd'}, ['c', 'z']);
8//=> true

.hasAll

Returns true if an array or object has all of the given values.

Params

• val {Object|Array}
• values {String|Array}
• returns {Boolean}

Example

1cu.hasAll(['a', 'b', 'c'], 'c');
2//=> true
3
4cu.hasAll(['a', 'b', 'c'], ['c', 'z']);
5//=> false
6
7cu.hasAll({a: 'b', c: 'd'}, ['c', 'z']);
8//=> false

.arrayify

Cast the given value to an array.

Params

• val {String|Array}
• returns {Array}

Example

1cu.arrayify('foo');
2//=> ['foo']
3
4cu.arrayify(['foo']);
5//=> ['foo']

.hasConstructor

Returns true if a value has a contructor

Params

• value {Object}
• returns {Boolean}

Example

1cu.hasConstructor({});
2//=> true
3
4cu.hasConstructor(Object.create(null));
5//=> false

.nativeKeys

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

1cu.nativeKeys({a: 'b', b: 'c', c: 'd'})
2//=> ['a', 'b', 'c']
3
4cu.nativeKeys(function(){})
5//=> ['length', 'caller']

.getDescriptor

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

1function App() {}
2Object.defineProperty(App.prototype, 'count', {
3  get: function() {
4    return Object.keys(this).length;
5  }
6});
7cu.getDescriptor(App.prototype, 'count');
8// returns:
9// {
10//   get: [Function],
11//   set: undefined,
12//   enumerable: false,
13//   configurable: false
14// }

.copyDescriptor

Copy a descriptor from one object to another.

Params

• receiver {Object}
• provider {Object}
• name {String}
• returns {Object}

Example

1function App() {}
2Object.defineProperty(App.prototype, 'count', {
3  get: function() {
4    return Object.keys(this).length;
5  }
6});
7var obj = {};
8cu.copyDescriptor(obj, App.prototype, 'count');

.copy

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 omit
• returns {Object}

.inherit

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 omit
• returns {Object}

.extend

Returns a function for extending the static properties, prototype properties, and descriptors from the Parent constructor onto Child constructors.

Params

• Parent {Function}: Parent ctor
• extend {Function}: Optional extend function to handle custom extensions. Useful when updating methods that require a specific prototype.
• Child {Function}: Child ctor
• proto {Object}: Optionally pass additional prototype properties to inherit.
• returns {Object}

Example

1var extend = cu.extend(Parent);
2Parent.extend(Child);
3
4// optional methods
5Parent.extend(Child, {
6  foo: function() {},
7  bar: function() {}
8});

.bubble

Bubble up events emitted from static methods on the Parent ctor.

Params

• Parent {Object}
• events {Array}: Event names to bubble up

About

1$ npm install && npm test

1$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

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

Contributors

Author

Jon Schlinkert

• linkedin/in/jonschlinkert
• github/jonschlinkert
• twitter/jonschlinkert

License

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

This file was generated by verb-generate-readme, v0.6.0, on January 11, 2018.