# vv-common

> many small functions for everyday use

Latest version **0.3.5** (published 2024-12-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install vv-common
pnpm add vv-common
yarn add vv-common
bun add vv-common
```

## Health

**Score 25/100 (F)** — status: maintenance-mode.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.5 |
| Published | 2024-12-04 |
| First published | 2021-10-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 155.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Vitalii Vasilev |
| Maintainers | vasilev.v.vitalii |

## Links

- npm: https://www.npmjs.com/package/vv-common
- Repository: https://github.com/VasilevVitalii/vv-common
- Homepage: https://github.com/VasilevVitalii/vv-common#readme
- Issues: https://github.com/VasilevVitalii/vv-common/issues
- npm.io page: https://npm.io/package/vv-common

## Recent versions

- 0.3.5 (latest) — 2024-12-04
- 0.3.4 — 2024-11-24
- 0.3.3 — 2024-11-24
- 0.3.2 — 2024-11-23
- 0.3.1 — 2024-11-23
- 0.2.5 — 2024-11-02
- 0.2.4 — 2024-11-02
- 0.2.3 — 2024-11-02
- 0.2.2 — 2024-11-02
- 0.2.1 — 2024-08-21
- 0.2.0 — 2024-08-09
- 0.1.9 — 2024-07-26
- 0.1.8 — 2024-01-27
- 0.1.7 — 2023-11-29
- 0.1.6 — 2023-10-31
- … 14 more at https://npm.io/package/vv-common/versions

## README

# vv-common

## Features
many small functions for everyday use
## License
***MIT***
## Use
```bash
npm i vv-common
```
```typescript
import * as vv from 'vv-common'
```
## Functions
### isEmpty
check variable is empty
```typescript
console.log(vv.isEmpty(false))		//false
console.log(vv.isEmpty('asf'))		//false
console.log(vv.isEmpty({a: 5}))		//false
console.log(vv.isEmpty({}))			//false
console.log(vv.isEmpty(undefined))	//true
console.log(vv.isEmpty('  '))		//true
console.log(vv.isEmpty(null))		//true
console.log(vv.isEmpty(NaN))		//true
```
### isFunction
check object is function
```typescript
console.log()

console.log(vv.isFunction(false))		//false
console.log(vv.isFunction('asf'))		//false
console.log(vv.isFunction({a: 5}))		//false
console.log(vv.isFunction({}))			//false
console.log(vv.isFunction(undefined))	//false
console.log(vv.isFunction(null)))		//false

function thisFunction() {
	console.log('I am function')
}

console.log(vv.isFunction(thisFunction))	//true
console.log(vv.isFunction(() => {}))		//true
```
### isGuid
check string is guid
```typescript
console.log(vv.isGuid(false))		//false
console.log(vv.isGuid('asf'))		//false
console.log(vv.isGuid({a: 5}))		//false
console.log(vv.isGuid({}))			//false
console.log(vv.isGuid(undefined))	//false
console.log(vv.isGuid('  '))		//false
console.log(vv.isGuid(null))		//false
console.log(vv.isGuid(NaN))			//false
console.log(vv.isGuid('A7C52954-1823-4C43-BBB4-C6099475B4C1'))	//true
console.log(vv.isGuid('00000000-0000-0000-0000-000000000000'))	//true
```
### isIp
check string is IP address
```typescript
console.log()
console.log(vv.isIp('192.999.5.6'))		//false
console.log(vv.isIp(false))				//false
console.log(vv.isIp('asf'))				//false
console.log(vv.isIp({a: 5}))			//false
console.log(vv.isIp({}))				//false
console.log(vv.isIp(undefined))			//false
console.log(vv.isIp('  '))				//false
console.log(vv.isIp(null))				//false
console.log(vv.isIp(NaN))				//false
console.log(vv.isIp('8.8.8.8'))			//true
console.log(vv.isIp('192.168.0.42'))	//true
```
### nz
return first non-empty (see function isEmpty) parameter
```typescript
console.log(vv.nz('a','b'))								//'a'
console.log(vv.nz(undefined,null,undefined,NaN,'','b'))	//'b'
```
### replace
replace all substrings in string
```typescript
console.log(vv.replace('a','b',null))		//null
console.log(vv.replace('a','b',undefined))	//undefined
console.log(vv.replace('a','b','123'))		//'123'
console.log(vv.replace('a','b','1a2a3'))	//'1b2b3'
```
### dateFormat
convert date to formatted string
```typescript
const DDD = new Date(1977, 10, 16, 14, 30, 42, 555)
console.log(vv.dateFormat(DDD, '126'))							//'1977-11-16T14:30:42.555'
console.log(vv.dateFormat(DDD, 'yy.mm).dd')						//'77.11.16'
console.log(vv.dateFormat(DDD, 'hh.mi).ss')						//'14.30.42'
console.log(vv.dateFormat(DDD, 'yyyy.mm).dd hh:mm:mi:ss.msec')	//'1977.11.16 14:11:30:42.555'
console.log(vv.dateFormat(DDD, 'yyyymmddhhmissmsec'))			//'19771116143042555'
```
### dateFormatOrdinal
return part of date
```typescript
const DDD = new Date(1977, 10, 16, 14, 30, 42, 555)
console.log(vv.dateFormatOrdinal(DDD, 'dayInYear')	//'320'
console.log(vv.dateFormatOrdinal(DDD, 'secInDay')	//'52242'
```
### dateParts
return date parts for milliseconds
```typescript
console.log(vv.dateParts(8))
	//{ day: 0, hour: 0, minute: 0, second: 0, millisecond: 8 }
console.log(vv.dateParts(999))
	//{ day: 0, hour: 0, minute: 0, second: 0, millisecond: 999 }
console.log(vv.dateParts(1000))
	//{ day: 0, hour: 0, minute: 0, second: 1, millisecond: 0 })
console.log(vv.dateParts(5123))
	//{ day: 0, hour: 0, minute: 0, second: 5, millisecond: 123 }
console.log(vv.dateParts(59999))
	//{ day: 0, hour: 0, minute: 0, second: 59, millisecond: 999 }
console.log(vv.dateParts(60000))
	// {day: 0, hour: 0, minute: 1, second: 0, millisecond: 0 }
console.log(vv.dateParts(3599999))
	//{ day: 0, hour: 0, minute: 59, second: 59, millisecond: 999 }
console.log(vv.dateParts(3600000))
	//{ day: 0, hour: 1, minute: 0, second: 0, millisecond: 0 }
console.log(vv.dateParts(3600000 + 60000 * 2 + 1000 * 3 + 42))
	//{ day: 0, hour: 1, minute: 2, second: 3, millisecond: 42 }
console.log(vv.dateParts(86399999))
	//{ day: 0, hour: 23, minute: 59, second: 59, millisecond: 999 }
console.log(vv.dateParts(86400000))
	//{ day: 1, hour: 0, minute: 0, second: 0, millisecond: 0 }
console.log(vv.dateParts(86400000 + 3600000 * 16 + 60000 * 30 + 1000 * 42 + 321))
	//{ day: 1, hour: 16, minute: 30, second: 42, millisecond: 321 }
```
### dateAdd
add date to date
```typescript
const DDD = new Date(1977, 10, 16, 14, 30, 42, 555)
console.log(vv.dateFormat(DDD, '126'))			//'1977-11-16T14:30:42.555'
console.log(vv.dateFormat(vv.dateAdd(DDD, 'day', 1), '126'))		//'1977-11-17T14:30:42.555'
console.log(vv.dateFormat(vv.dateAdd(DDD, 'hour', 1), '126'))		//'1977-11-16T15:30:42.555'
console.log(vv.dateFormat(vv.dateAdd(DDD, 'minute', 1), '126'))		//'1977-11-16T14:31:42.555'
console.log(vv.dateFormat(vv.dateAdd(DDD, 'second', 1), '126'))		//'1977-11-16T14:30:43.555'
console.log(vv.dateFormat(vv.dateAdd(DDD, 'day', -1), '126'))		//'1977-11-15T14:30:42.555'
console.log(vv.dateFormat(vv.dateAdd(DDD, 'hour', -1), '126'))		//'1977-11-16T13:30:42.555'
console.log(vv.dateFormat(vv.dateAdd(DDD, 'minute', -1), '126'))	//'1977-11-16T14:29:42.555'
console.log(vv.dateFormat(vv.dateAdd(DDD, 'second', -1), '126'))	//'1977-11-16T14:30:41.555'
```
### toString
convert variable to string
```typescript
const DDD = new Date(1977, 10, 16, 14, 30, 42, 555)
console.log(vv.toString(undefined))	//''
console.log(vv.toString('aa'))		//'aa'
console.log(vv.toString(100.34))	//'100.34'
console.log(vv.toString(true))		//'true'
console.log(vv.toString(DDD) )		//'1977-11-16T14:30:42.555'
```
### toInt
convert variable to integer value
```typescript
console.log(vv.toInt('aa'))			//undefined
console.log(vv.toInt(100.34))		//undefined
console.log(vv.toInt(true))			//1
console.log(vv.toInt(false))		//0
console.log(vv.toInt(new Date()))	//undefined
console.log(vv.toInt('42'))			//42
console.log(vv.toInt('-42'))		//-42
```
### toIntPositive
convert variable to positive integer value
```typescript
console.log(vv.toInt('aa'))			//undefined
console.log(vv.toInt(100.34))		//undefined
console.log(vv.toInt(true))			//1
console.log(vv.toInt(new Date()))	//undefined
console.log(vv.toInt('42'))			//42
console.log(vv.toInt('-42'))		//undefined
```
### toFloat
convert variable to float value
```typescript
console.log(vv.toFloat('aa'))		//undefined
console.log(vv.toFloat(100.34))		//100.34
console.log(vv.toFloat(true))		//1
console.log(vv.toFloat(false))		//0
console.log(vv.toFloat(new Date()))	//undefined
console.log(vv.toFloat('42'))		//42
console.log(vv.toFloat('-42'))		//-42
console.log(vv.toFloat('42.11'))	//42.11
console.log(vv.toFloat('-42.22'))	//-42.22
console.log(vv.toFloat('42,11'))	//42.11
console.log(vv.toFloat('-42,22'))	//-42.22
```
### toBool
convert variable to boolean value
```typescript
console.log(vv.toBool('aa'))		//undefined
console.log(vv.toBool(100.34))		//undefined
console.log(vv.toBool(true))		//true
console.log(vv.toBool(false))		//false
console.log(vv.toBool(new Date()))	//undefined
console.log(vv.toBool('true'))		//true
console.log(vv.toBool('1'))			//true
console.log(vv.toBool(1))			//true
console.log(vv.toBool('false'))		//false
console.log(vv.toBool('0'))			//false
console.log(vv.toBool(0))			//false
console.log(vv.toBool('yes'))		//true
console.log(vv.toBool('no'))		//false
```
### toDate
convert variable to date value
```typescript
const DDD = new Date(1977, 10, 16, 14, 30, 42, 555)
console.log(vv.toDate('aa'))	//undefined
console.log(vv.toDate(1))		//undefined
console.log(vv.toDate(true))	//undefined
console.log(vv.dateFormat(vv.toDate(DDD), '126'))						//'1977-11-16T14:30:42.555'
console.log(vv.dateFormat(vv.toDate('1977-11-16T14:30:42.555'), '126'))	//'1977-11-16T14:30:42.555'
console.log(vv.dateFormat(vv.toDate('1977.11.16'), '126'))				//'1977-11-16T00:00:00.000'
console.log(vv.dateFormat(vv.toDate('1977-11-16'), '126'))				//'1977-11-16T00:00:00.000'
```
### toArray
convert variable to array
```typescript
console.log(vv.toArray('aa'))	//undefined
console.log(vv.toArray(100.34))	//undefined
console.log(vv.toArray([]))		//[]
console.log(vv.toArray([1,2]))	//[1,2]
```
### toLexem
split string by dividers
```typescript
console.log(vv.toLexem('/*comment */\nlet a=4*5', [' ', '/*', '*/', '*', '\n']))
// result in console (without brackets):
// "/*"
// "comment"
// " "
// "*/"
// "\n"
// let
// " "
// a=4
// *
// 5
```
### equal
compare two variables
```typescript
const DDD1 = new Date(1977, 10, 16, 14, 30, 42, 555)
const DDD2 = new Date(1977, 10, 16, 14, 30, 42, 555)
console.log(vv.equal(' AA ', 'aa'))			//true
console.log(vv.equal(DDD1,DDD2))			//true
console.log(vv.equal(DDD1,new Date()))		//false
console.log(vv.equal(undefined, undefined))	//true
console.log(vv.equal(4, undefined))			//false
console.log(vv.equal('a', 'b'))				//false
console.log(vv.equal(10,10))				//true
console.log(vv.equal(undefined, null))		//true
console.log(vv.equal(undefined, NaN))		//true
console.log(vv.equal(null, NaN))			//true
console.log(vv.equal(undefined, ''))		//true
console.log(vv.equal('', null))				//true
```
### prop
return property from object
```typescript
const OBJ = {
    aaa: 5,
    bbb: '1',
    arr: [1, 2, 3]
}
console.log(vv.prop(OBJ, 'AAA'))	//5
console.log(vv.prop(OBJ, 'bbb'))	//'1'
console.log(vv.prop(OBJ, 'Arr'))	//[1,2,3]
console.log(vv.prop(OBJ, 'yyy'))	//undefined
```
### guid
very simple gererator non-uniq guid
```typescript
console.log(vv.guid())	//388CEC00-34C3-45F0-8542-C61187BA2B6B
console.log(vv.guid())	//C38FDE41-1086-4B30-CBB1-DC5CDF18E1D6
```
### PackajeJsonParse
return package.json as object
```typescript
const p = [
    '{',
    '    "name": "vv-common",',
    '    "version": "0.0.5",',
    '    "description": "many small functions for everyday use",',
    '    "main": "dist/src/index.js",',
    '    "scripts": {',
    '        "test": "node ./dist/test/index.js",',
    '        "update": "npx npm-check-updates -u && npm i && npm audit fix && node ./node_modules/vv-template-nodebackend/index.js",',
    '        "build": "tsc",',
    '        "precommit": "node ./.auto/precommit.js"',
    '    },',
    '    "repository": {',
    '        "type": "git",',
    '        "url": "git+https://github.com/VasilevVitalii/vv-common.git"',
    '    },',
    '    "author": "Vitalii Vasilev",',
    '    "license": "MIT",',
    '    "bugs": {',
    '        "url": "https://github.com/VasilevVitalii/vv-common/issues"',
    '    },',
    '    "homepage": "https://github.com/VasilevVitalii/vv-common#readme",',
    '    "devDependencies": {',
    '        "vv-template-nodebackend": "0.0.12",',
    '        "@types/node": "16.11.6",',
    '        "@typescript-eslint/eslint-plugin": "5.2.0",',
    '        "@typescript-eslint/parser": "5.2.0",',
    '        "eslint": "8.1.0",',
    '        "npm-check-updates": "11.8.5",',
    '        "prettier": "2.4.1",',
    '        "ts-node": "10.4.0",',
    '        "typescript": "4.4.4"',
    '    }',
    '}',
].join('\n')
const pp = vv.PackajeJsonParse(p)
console.log(pp.name)					//'vv-common'
console.log(pp.version)					//'0.0.5'
console.log(pp.devDependencies.length)	//9
```

### Timer
simple timer, based on nested call setTimeout; manual control of each subsequent tick
```typescript
const counter = {i: 0}
console.log('first tick after 50 msec')
const t = new vv.Timer(50, () => {
    counter.i++
    if (counter.i < 5) {
        console.log('next tick after 100 msec')
        t.nextTick(100)
        return
    }
    if (counter.i < 10) {
        console.log('next tick after 200 msec')
        t.nextTick(200)
        return
    }
    console.log('this last tick')
})
```

### Mere
class for work with date and time
```typescript
const mereDateTime1 = new vv.MereDateTime() //now
const mereDateTime2 = new vv.MereDateTime() //empty
const mereDateTime3 = new vv.MereDateTime('20240115')
const mereDateTime4 = new vv.MereDateTime({val: 'aaa', defVal: '12.04.2018 16:35'})
console.log(mereDateTime1.toString(), mereDateTime1.toJSON()) //in format "yyyy-mm-ddThh:mi:ss.msec"
console.log(mereDateTime2.toString(), mereDateTime2.toJSON()) //''
console.log(mereDateTime3.toString(), mereDateTime3.toJSON()) //'2024-01-15T00:00:00.000'
console.log(mereDateTime4.toString(), mereDateTime4.toJSON()) //'2018-04-12T16:35:00.000'

const mereDate1 = new vv.MereDate() //now
const mereDate2 = new vv.MereDate() //empty
const mereDate3 = new vv.MereDate('20240115')
const mereDate4 = new vv.MereDate({val: 'aaa', defVal: '12.04.2018 16:35'})
console.log(mereDate1.toString(), mereDate1.toJSON()) //in format "yyyy-mm-dd"
console.log(mereDate2.toString(), mereDate2.toJSON()) //''
console.log(mereDate3.toString(), mereDate3.toJSON()) //'2024-01-15'
console.log(mereDate4.toString(), mereDate4.toJSON()) //'2018-04-12'

const mereTime1 = new vv.MereTime() //now
const mereTime2 = new vv.MereTime() //empty
const mereTime3 = new vv.MereTime('3')
const mereTime4 = new vv.MereTime('3:45')
const mereTime5 = new vv.MereTime({val: 'aaa', defVal: '12.04.2018 16:35'})

console.log(mereTime1.toString(), mereTime1.toJSON()) //in format "hh:mi:ss.msec"
console.log(mereTime2.toString(), mereTime2.toJSON()) //''
console.log(mereTime3.toString(), mereTime3.toJSON()) //'03:00:00.000'
console.log(mereTime4.toString(), mereTime4.toJSON()) //'03:45:00.000'
console.log(mereTime5.toString(), mereTime4.toJSON()) //'16:35:00.000'
```

### Range
limiting a variable to multiple integer values
```typescript
let aaa =undefined as vv.TRange<0,5>
aaa = -1    //error
aaa = 0     //ok
aaa = 1     //ok
aaa = 2     //ok
aaa = 3     //ok
aaa = 3.5   //error
aaa = 4     //ok
aaa = 5     //error
console.log(aaa)
```

---
_Source: https://npm.io/package/vv-common · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._