# Chober.js
[](https://app.codacy.com/app/BrooonS/chober?utm_source=github.com&utm_medium=referral&utm_content=BrooonS/chober&utm_campaign=Badge_Grade_Dashboard)
[](https://brooons.github.io/chober/)
[](https://www.jsdelivr.com/package/npm/chober)
[](https://brooons.github.io/chober/)
Star
Watch
[Docs](https://brooons.github.io/chober/) | [Licence](https://github.com/BrooonS/chober/blob/master/LICENSE)
> A collection of useful 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.
> You can try to write code in this page. Just open console and start writing.
## Quick start
Install with [npm](https://www.npmjs.com/package/chober).
```sh
npm i chober
```
or download and install with `script`.
```html
```
or cdn
```html
```
### npm
#### Import one method
```js
// ES6
import { isEmpty } from 'chober';
```
```js
// CommonJS
const { isEmpty } = require('chober');
```
```JS
isEmpty([]);
// => true
```
#### Import all library and use all methods
```js
// ES6
import _c from 'chober';
```
```js
// CommonJS
const _c = require('chober');
```
```js
_c.isEmpty([]);
// => true
_c.clone({ key: 'value' });
// => { key: 'value' }
```
#### Import only one method
If you import one method, other methods will not be imported.
```js
// ES6
import isEmpty from 'chober/lib/isEmpty'; // ~600B
```
```js
// CommonJS
const isEmpty = require('chober/lib/isEmpty'); // ~600B
```
```js
isEmpty([]);
// => true
```
### Browser
`_c` binds to the `window`.
```html
```
```js
_c.isEmpty([]);
// => true
```
## Methods
### clone
Clone any item with nested items.
#### Since
- 0.1.0
#### Params
- `item`
- Type: `Any`
- Description: *Some item to clone.*
#### Returns
- `Any`
#### Example
```JS
clone([1, null, '3'])
// => [1, null, '3']
```
Source code
* * *
### flattenDeep
Flatten an array.
#### Since
- 1.2.0
#### Params
- `array`
- Type: `Array`
- Description: *Array for flat.*
#### Returns
- `Array`
#### Example
```JS
flattenDeep([123, [456, [567, [890]]]])
// => [123, 456, 567, 890]
```
Source code
* * *
### formatNumber
Format number.
#### Since
- 0.1.0
#### Params
- `number`
- Type: `Number,String`
- `symbol`
- Type: `String`
- Description: *Symbol to be inserted. Default ` `.*
#### Returns
- `Number`
#### Example
```JS
formatNumber(1234)
// => '1 234'
formatNumber('1234', ',')
// => '1,234'
```
Source code
* * *
### formatQuery
Format query to set to url.
#### Since
- 2.0.0
#### Params
- `arrayFields`
- Type: `Array`
- Description: *Fields that must be arrays.*
#### Returns
- `Object`
#### Example
```JS
const query = { value: 'test', field: ['hi', 'hello'] };
formatQuery(query)
// => value=test&field=hi&field=hello
const query = { value: ['test'], field: 'hi' }
formatQuery(query, true)
// => value[]=test&field=hi
```
Source code
* * *
### getCookie
Get cookie.
#### Since
- 0.1.0
#### Params
- `key`
- Type: `String`
- Description: *Cookie name.*
#### Returns
- `String`
#### Example
```JS
getCookie('someCookie')
```
Source code
* * *
### getOffset
Get absolute coordinates of an element.
#### Since
- 0.1.0
#### Params
- `item`
- Type: `String,HTMLElement`
- Description: *Selector or HTML element to get coordinates of.*
#### Returns
- `Object`
#### Example
```JS
getOffset('.j-block').left
// => 8
getOffset(document.querySelector('.j-block')).left
// => 8
```
Source code
* * *
### getQuery
Get query from url.
#### Since
- 0.1.0
#### Params
- `arrayFields`
- Type: `Array`
- Description: *Fields that must be arrays.*
#### Returns
- `Object`
#### Example
```JS
// /?value=test&field=hi&field=hello
getQuery()
// => { value: 'test', field: ['hi', 'hello'] }
// /?value=test&field=hi
getQuery({ arrays: ['value'] })
// => { value: ['test'], field: 'hi' }
// /?value=test&field=hi&value=123&test=true
getQuery()
// => { value: ['test', 123], field: 'hi', test: true }
```
Source code
* * *
### getScrollbarWidth
Get scrollbar width.
#### Since
- 0.1.0
#### Returns
- `Number`
Source code
* * *
### getType
Get object type.
#### Since
- 0.2.0
#### Params
- `object`
- Type: `Any`
- Description: *Any type.*
#### Returns
- `String`
#### Example
```JS
getType({})
// => 'object'
getType([])
// => 'array'
```
Source code
* * *
### groupBy
Group items of an array by their specific property.
#### Since
- 2.0.0
#### Params
- `arr`
- Type: `Array`
- Description: *An array/collection to group.*
- `param`
- Type: `String`
- Description: *A parameter of array's item to group by.*
- `withoutKeys`
- Type: `Boolean`
- Description: *Remove keys from object and get an array.*
#### Returns
- `Object`
#### Example
```JS
const array = [
{ id: 1, prop1: 'a', prop2: ['d', 'y'] },
{ id: 2, prop1: 'a', prop2: 'c' },
{ id: 3, prop1: 'b', prop2: 'd' },
];
groupBy(array, 'prop2');
// => {
// d: [
// { id: 1, prop1: 'a', prop2: ['d', 'y'] },
// { id: 3, prop1: 'b', prop2: 'd' }
// ],
// y: [
// { id: 1, prop1: 'a', prop2: ['d', 'y'] }
// ],
// c: [
// { id: 2, prop1: 'a', prop2: 'c' }
// ]
// }
groupBy(array, 'prop1', true);
// => [
// [
// { id: 1, prop1: 'a', prop2: ['d', 'y'] },
// { id: 2, prop1: 'a', prop2: 'c' },
// ],
// [
// { id: 3, prop1: 'b', prop2: 'd' },
// ],
// ]
```
Source code
* * *
### isArray
Checking the item for is an array.
#### Since
- 1.0.0
#### Params
- `item`
- Type: `Any`
- Description: *Item to check.*
#### Returns
- `Boolean`
#### Example
```JS
isArray([])
// => true
isArray({})
// => false
```
Source code
* * *
### isBoolean
Checking the item for is a boolean.
#### Since
- 1.0.0
#### Params
- `item`
- Type: `Any`
- Description: *Item to check.*
#### Returns
- `Boolean`
#### Example
```JS
isBoolean(true)
// => true
isBoolean([])
// => false
```
Source code
* * *
### isEmpty
Check is empty object, string, array or other type.
#### Since
- 0.1.0
#### Params
- `item`
- Type: `Any`
- Description: *Some item to check.*
#### Returns
- `Boolean`
#### Example
```JS
isEmpty({ test: 'some value' })
// => false
isEmpty([1, null, '3'])
// => false
isEmpty('qwe')
// => false
isEmpty(true)
// => true
isEmpty(1)
// => true
isEmpty(undefined)
// => true
isEmpty(null)
// => true
```
Source code
* * *
### isEqual
Checking is equal items.
#### Since
- 1.1.0
#### Params
- `firstItem`
- Type: `Any`
- Description: *First item to check.*
- `secondItem`
- Type: `Any`
- Description: *Second item to check.*
#### Returns
- `Boolean`
#### Example
```JS
isEqual([], [])
// => true
isEqual({ test: 'value' }, { test: 'value' })
// => true
isEqual(true, false)
// => false
```
Source code
* * *
### isFunction
Checking the item for is a function.
#### Since
- 1.3.0
#### Params
- `item`
- Type: `Any`
- Description: *Item to check.*
#### Returns
- `Boolean`
#### Example
```JS
isFunction(() => {})
// => true
isFunction(null)
// => false
isFunction(false)
// => false
isFunction([])
// => false
```
Source code
* * *
### isNil
Checking the item for is a null or undefined.
#### Since
- 1.3.0
#### Params
- `item`
- Type: `Any`
- Description: *Item to check.*
#### Returns
- `Boolean`
#### Example
```JS
isNil(undefined)
// => true
isNil(null)
// => true
isNil(false)
// => false
isNil('')
// => false
```
Source code
* * *
### isNumber
Checking the item for is a number.
#### Since
- 1.0.0
#### Params
- `item`
- Type: `Any`
- Description: *Item to check.*
#### Returns
- `Boolean`
#### Example
```JS
isNumber(123)
// => true
isNumber([])
// => false
```
Source code
* * *
### isObject
Checking the item for is an object.
#### Since
- 1.0.0
#### Params
- `item`
- Type: `Any`
- Description: *Item to check.*
#### Returns
- `Boolean`
#### Example
```JS
isObject({})
// => true
isObject(123)
// => false
```
Source code
* * *
### isString
Checking the item for is a string.
#### Since
- 1.0.0
#### Params
- `item`
- Type: `Any`
- Description: *Item to check.*
#### Returns
- `Boolean`
#### Example
```JS
isString('string')
// => true
isString([])
// => false
```
Source code
* * *
### isUndefined
Checking the item for is a undefined.
#### Since
- 1.2.0
#### Params
- `item`
- Type: `Any`
- Description: *Item to check.*
#### Returns
- `Boolean`
#### Example
```JS
isUndefined(undefined)
// => true
isUndefined('testValue')
// => false
```
Source code
* * *
### removeCookie
Remove cookie.
#### Since
- 0.1.0
#### Params
- `key`
- Type: `String`
- Description: *Cookie name.*
#### Example
```JS
removeCookie('testCookie')
```
Source code
* * *
### scrollTo
Scroll to element in DOM.
#### Since
- 0.2.0
#### Params
- `item`
- Type: `String,HTMLElement`
- Description: *Selector or HTML element to which to scroll.*
- `isHorizontalEnabled`
- Type: `Boolean`
- Description: *Enable horizontal scroll. Default: false.*
#### Example
```JS
scrollTo(document.querySelector('.j-block'))
scrollTo('.j-block')
```
Source code
* * *
### setCookie
Set cookie.
#### Since
- 0.1.0
#### Params
- `key`
- Type: `String`
- Description: *Cookie name.*
- `value`
- Type: `String`
- Description: *Cookie value.*
- `expireIn`
- Type: `Number`
- Description: *Time in milliseconds to expire cookie.*
#### Example
```JS
setCookie('name', 'value', 60000) // 60000 - one minute
```
Source code
* * *
### setQuery
Set query to url.
#### Since
- 0.3.0
#### Params
- `query`
- Type: `Object`
- Description: *Object to parse in url.*
- `params`
- Type: `Object`
- Description: *Object with params.*
- `params.isSaveOld`
- Type: `Boolean`
- Description: *Does save old query. Default: false.*
- `params.isSaveHash`
- Type: `Boolean`
- Description: *Does save hash. Default: true.*
- `params.isSaveEmptyFields`
- Type: `Boolean`
- Description: *Does save empty fields. Default: false.*
#### Example
```JS
setQuery({ test: 'value' })
// => /?test=value
setQuery({ test: ['12', '34'] })
// => /?test=12&test=34
// /?test=value&field=test
setQuery({ test: 'field' }, { isSaveOld: true })
// => /?test=value&test=field&field=test
// /?test=value#someHash
setQuery({ test: 'value' }, { isSaveHash: false })
// => /?test=value
```
Source code
* * *
### uniq
Remove same values from array.
#### Since
- 0.3.0
#### Params
- `array`
- Type: `Array`
- Description: *Array of values.*
#### Returns
- `Array`
#### Example
```JS
uniq(['test', 'field', 'test'])
// => ['test', 'field']
uniq([{ test: 'value' }, { test: 'value' }])
// => [{ test: 'value' }]
uniq([['someValue'], ['someOtherValue'], ['someValue']])
// => [['someValue'], ['someOtherValue']]
```
Source code
* * *
© Valery Strelets