Utils-igor NPM

utils-igor

Installation

npm install utils-igor

### Example
package.json

```json
{
  "name": "test_util",
  "version": "0.0.1",
  "description": "",
  "main": "index.js",
  "license": "UNLICENSED",
  "dependencies" : {
    "express" : "*",
    "async": "1.4.2",
    "utils-igor" : "*"
  }
}

index.js

/**
 * Created by igor on 30.05.16.
 */
/* globals process, require */

var express = require('express');
var app     = express();
var port    = process.env.PORT || 3000;


app.get('/', function (req, res) {

	// include all blocks
	var utils = require('utils-igor')();

	var arr = [2,3,4,4,4,4,5];
	var obj = {};

	res.send( 200,{
		objEmpty   : utils.obj.isEmpty(obj),
		isFunction : utils.type.isFn(obj),
		arr        : utils.arr.unique(arr)
	});

});

app.listen(port, function () {
	console.log('Example app listening on port '+ port + '!');
});

Result:

{"objEmpty":true,"isFunction":false,"arr":[2,3,4,5]}

To include one block change

	- var utils = require('utils-igor')();
	+ var utils = require('utils-igor')('obj');

To include more than one block change

	- var utils = require('utils-igor')();
	+ var utils = require('utils-igor')(['obj', 'arr']);

Modules

arr

Function for array

arr
- .mvVal
  - new exports.mvVal(arr, value)
- .check(arr)
- .sortNumber(a, b) ⇒ number
- .share(arr1, arr2) ⇒ Array
- .diff(arr1, arr2) ⇒ Array
- .unique(arr)
- .sum() ⇒ Number
- .avg(a) ⇒ number
- .urls(arr) ⇒ Array

arr.mvVal

Kind: static class of arr

new exports.mvVal(arr, value)

Delete all elements whith specified value

Param	Type	Description
arr	Array	массив для очистки
value	*	значение

arr.check(arr)

Check parameter be array. if not return empty array

Kind: static method of arr

Param	Type
arr	*

arr.sortNumber(a, b) ⇒ number

By default the sort method sorts elements alphabetically. To sort numerically just add a new method which handles numeric sorts e.g. 11, 1, 2.sort(utils.sortNumber);

Kind: static method of arr

Param	Type
a	Number
b	Number

arr.share(arr1, arr2) ⇒ Array

Return share part of the array

Kind: static method of arr

Param
arr1
arr2

arr.diff(arr1, arr2) ⇒ Array

Return different part of the array

Kind: static method of arr

Param	Type
arr1	Array
arr2	Array

arr.unique(arr)

Clear repeat values

Kind: static method of arr

Param	Type
arr	Array

arr.sum() ⇒ Number

Sum of array elements

Kind: static method of arr

arr.avg(a) ⇒ number

Return average elements array

Kind: static method of arr

Param	Type
a	Array

arr.urls(arr) ⇒ Array

Return array. When element is url collect from specified array

Kind: static method of arr

Param	Type
arr	Array

date

Function for date

date
- static
  - .ts : Object
  - .time(ts)
  - .date(shiftDays, ts, format) ⇒ string
  - .dateTime(shiftDays, ts, format)
  - .tsToSec(ts, up)
  - .tsToMin(ts, up)
  - .secToTs(sec)
  - .minToTs(min)
- inner
  - ~unix(ts)
  - ~round(number, up)

date.ts : Object

Time constant in milliseconds

Kind: static property of date

date.time(ts)

Get time string

Kind: static method of date

Param	Type
ts	Number \| null \| undefined

Example

'11:40:46'

date.date(shiftDays, ts, format) ⇒ string

Get date string

Kind: static method of date

Param	Type
shiftDays	Number \| null
ts	Number \| null \| undefined
format	string \| null \| undefined

Example

date() => '2014-11-30'

Example

date(null, null, 'd-m-y') => '30-11-2014'

date.dateTime(shiftDays, ts, format)

Get date time string

Kind: static method of date

Param	Type
shiftDays	Number \| null \| undefined
ts	Number \| null \| undefined
format	String \| null \| undefined

Example

'2014-11-30 11:40:46'

Example

dateTime() this work

date.tsToSec(ts, up)

unix-time to seconds

Kind: static method of date

Param	Type
ts	Number \| null \| undefined
up	boolean \| null

Example

1417323330

date.tsToMin(ts, up)

unix-time to minutes

Kind: static method of date

Param	Type
ts	Number \| null \| undefined
up	boolean \| null

Example

23622056

date.secToTs(sec)

seconds to unix-time

Kind: static method of date

Param	Type
sec	Number

Example

1417323330

date.minToTs(min)

minutes to unix-time

Kind: static method of date

Param	Type
min	Number

Example

23622056

date~unix(ts)

Return date (now or by unixTime).

Kind: inner method of date

Param	Type
ts	Number \| null \| undefined

date~round(number, up)

Be round up or down

Kind: inner method of date

Param	Type
number	Number
up	boolean \| null

obj

Function for object

obj
- static
  - .arrToObjByKey(arr, prop, fnIterProp) ⇒ Object
  - .keysChange(obj, keys) ⇒ Object
  - .sort(obj, down) ⇒ Object
  - .propInc(obj, prop, byVal)
  - .beInObj(ob, prop, def)
  - .pathCreate(obj, path, def)
  - .isPathExist(obj, path) ⇒ Boolean
  - .pathVal(obj, path) ⇒ *
  - .pathMv(obj, path) ⇒ *
  - .urlParams(obj) ⇒ string
  - .ext(obj, add) ⇒ *
  - .getPropToArr(arObj, prop) ⇒ Array
  - .propToArr(obj) ⇒ Array
  - .each(obj, fn, fnSort)
  - .isEmpty(obj) ⇒ boolean
  - .beRound(ob, prop, round)
- inner
  - ~isObj(obj) ⇒ boolean
  - ~isSet(v)