chober

Chober.js

Docs | Licence

A collection of methods that are used by programmers every day. We decided to put all the methods together so as not to copy them from project to project.

Quick start

Install with npm.

$ npm i chober

or download and install with script.

<script src="chober.min.js"></script>

or cdn

<!-- Latest -->
<script src="https://cdn.jsdelivr.net/npm/chober/dist/chober.min.js"></script>

<!-- With version -->
<script src="https://cdn.jsdelivr.net/npm/chober@0.1.0/dist/chober.min.js"></script>

npm

Import one method

import { isEmpty } from 'chober';

isEmpty([]);
// => true

Import all library and use all methods

import _c from 'chober';

_c.isEmpty([]);
// => true

_c.clone({ key: 'value' });
// => { key: 'value' }

Import only one method

If you import one method, other methods will not be imported.

import isEmpty from 'chober/lib/isEmpty'; // ~600B

isEmpty([]);
// => true

Browser

_c binds to the window.

<script src="chober.min.js"></script>

_c.isEmpty([]);
// => true

Add your methods

If you want to add your methods, read the instructions below.

• Clone repository git clone https://github.com/BrooonS/chober.git.
• Add method to lib folder. Example: lib/yourMethod.js.
• Add comments to function params, if they exist.
• Import method to index.js.
• Run npm run build command.

Example

// lib/yourMethod.js

/**
 * Method to sum two numbers.
 *
 * @param {Number} a First number.
 * @param {Number} b Second number.
 * @returns {Number}
 *
 * @example
 * math(2, 2)
 * // => 4
 */
function math(a, b) {
  return a + b;
}

export default math;

// index.js

import yourMethod from './lib/yourMethod';

export {
  ... // other methods
  yourMethod,
};

class Chober {
  constructor() {
    Object.assign(this, {
      ... // other methods
      yourMethod,
    });
  }
}

Methods

All methods you can find in our documentation.

---

© Valery Strelets