# legions-utils-tool

> 常用工具类操作方法

Latest version **0.0.11** (published 2021-07-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install legions-utils-tool
pnpm add legions-utils-tool
yarn add legions-utils-tool
bun add legions-utils-tool
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.11 |
| Published | 2021-07-19 |
| First published | 2020-09-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 116 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | duanguang |
| Maintainers | duanguang |
| Keywords | utils, tool, legions-utils-tool |

## Links

- npm: https://www.npmjs.com/package/legions-utils-tool
- Repository: https://github.com/duanguang/legion-guard/tree/develop/packages/legions-utils-tool
- npm.io page: https://npm.io/package/legions-utils-tool

## Dependencies (1)

- [javascript-state-machine](https://npm.io/package/javascript-state-machine.md) ^3.1.0

## Alternatives

- [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads
- [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads
- [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads
- [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads
- [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads

## Recent versions

- 0.0.11 (latest) — 2021-07-19
- 0.0.10 — 2020-12-08
- 0.0.9 — 2020-12-07
- 0.0.9-rc.2 — 2020-12-07
- 0.0.9-rc.1 — 2020-11-03
- 0.0.8 — 2020-10-27
- 0.0.6 — 2020-09-16

## README

# `legions-utils-tool`

> TODO: 常用工具类函数

## Usage

```md
npm install --save legions-utils-tool
```

## API

### cookie

> 设置cookie值

```js
import {setCookie} from 'legions-utils-tool/cookie'
```

> 获取cookie值

```js
import { getCookie } from 'legions-utils-tool/cookie';
```

> 移除cookie

```js
import { removeCookie } from 'legions-utils-tool/cookie';
```

> 清空cookie

```js
import { clearAllCookie } from 'legions-utils-tool/cookie';
```

### debounce防抖函数

```js
import {debounce} from 'legions-utils-tool/debounce';
debounce(()=>{
    //doSth
},1000)
```

### DOM节点事件

> DOM节点绑定事件

```js
import {on} from 'legions-utils-tool/dom'
```

> 卸载DOM元素节点事件

```js
import {off} from 'legions-utils-tool/dom'
```

### download

> 支持一次下载多份文件

```js
import {download} from 'legions-utils-tool/download'
download([文件链接数组])
```

### format-date日期格式化

> 将日期格式化成指定格式的字符串

```js
import {formatDate} from 'legions-utils-tool/format.date'
```

> 将字符串解析成日期

```js
import {parseDate} from 'legions-utils-tool/format.date'
```

> 将一个日期格式化成友好格式，比如，1分钟以内的返回“刚刚”, 当天的返回时分，当年的返回月日，否则，返回年月日

```js
import {formatDateToFriendly} from 'legions-utils-tool/format.date'
```

> 将一段时长转换成友好格式,如：1581->“26分21秒”

```js
import {formatDurationToFriendly} from 'legions-utils-tool/format.date'
```

> 将时间转换成MM:SS形式

```js
import {formatTimeToFriendly} from 'legions-utils-tool/format.date'
```

> 判断某一年是否是闰年

```js
import {isLeapYear} from 'legions-utils-tool/format.date'
```

> 获取某一年某一月的总天数，没有任何参数时获取当前月份的

```js
import {getMonthDays} from 'legions-utils-tool/format.date'
```

> 计算2日期之间的天数，用的是比较毫秒数的方法

```js
import {countDays} from 'legions-utils-tool/format.date'
```

> 获取指定日期月数最后一天

```js
import {getLastDay} from 'legions-utils-tool/format.date'
```

### fomate-string字符串格式化

> 字符串去除空格

```js
import {formatTrim} from 'legions-utils-tool/format.string'
```

> 千位分割

```js
import {formatLocaleString} from 'legions-utils-tool/format.string'
```

> 保留指定位数小数

```js
import {number} from 'legions-utils-tool/format.string'
```

> 金额保留两位小数

```js
import {amount} from 'legions-utils-tool/format.string'
```

>  判断字符串是否是json

```js
import {isJSON} from 'legions-utils-tool/format.string'
```

>  获取字符串长度

```js
import {getStringLen} from 'legions-utils-tool/format.string'
```

### object-utils对象的操作方法

> 对数组或对象进行自然排序

```js
import {sort} from 'legions-utils-tool/object.utils'
// 升序
sort([3,2,4]) === [2, 3, 4]
// 根据指定的属性值进行排序
sort([{age:1,name:'jucy'},{age:4,name:'cody'},{age:2,name:'cinlo'}],'name') === [{age:2,name:'cinlo'},{age:4,name:'cody'},{age:1,name:'jucy'}]
```

> 通用排序

```js
import {compare} from 'legions-utils-tool/object.utils'
compare('4','2') === 1
compare('2','2') === 0
compare('1','2') === -1
```

> 排除指定对象属性

```js
import {excludeObj} from 'legions-utils-tool/object.utils'
excludeObj({age:1,name:'jucy',grade:2},{age:1,name:'jucy',sex:'girl',like:'football'}) === {sex:'girl',like:'football'}
```

> promiseTry

```js
import {promiseTry} from 'legions-utils-tool/object.utils'
promiseTry(()=>'xixi').then(res=>res === 'xixi')
```

> proxyGetters

```js
import {proxyGetters} from 'legions-utils-tool/object.utils'
let objTest = {}
proxyGetters(objTest,{'age':1,'name':'cici','sex':'girl'},['name'])
console.log(objTest['name'])//'cici'
```

### regex常用正则表达式校验

```js
import {RegExChk,commonRegex,validatorType} from 'legions-utils-tool/regex'
RegExChk(commonRegex.PRICE,'10000000000.3111111')//使用已封装好的正则表达式或者自己书写的正则表达式
RegExChk(validatorType.chinese,'中国，我爱中国')//使用已有的正则表达式类型
```

### type-validation数据基本类型判断

```js
import {isObject,isUndefined,isNull,isPromise,isNullUndefined} from 'legions-utils-tool/type.validation'
```

### storage

> 设置相应键值缓存信息

```js
import {setStorageItems} from 'legions-utils-tool/storage'
```

> 获取相应键值缓存信息

```js
import {getStorageItem} from 'legions-utils-tool/storage'
```

##  state.machine

### used

```js
import {stateMachine} from 'legions-utils-tool/state.machine';

var fsm = new stateMachine({
    init: 'solid',
    transitions: [
      { name: 'melt',     from: 'solid',  to: 'liquid' },
      { name: 'freeze',   from: 'liquid', to: 'solid'  },
      { name: 'vaporize', from: 'liquid', to: 'gas'    },
      { name: 'condense', from: 'gas',    to: 'liquid' }
    ],
    methods: {
      onMelt:   function() { console.log('I melted')    },
      onFreeze:   function() { console.log('I froze')     },
      onVaporize: function() { console.log('I vaporized') },
      onCondense: function() { console.log('I condensed') }
    }
  });
```

... which creates an object with a current state property:

  * `fsm.state`

... methods to transition to a different state:

  * `fsm.melt()`
  * `fsm.freeze()`
  * `fsm.vaporize()`
  * `fsm.condense()`

... observer methods called automatically during the lifecycle of a transition:

  * `onMelt()`
  * `onFreeze()`
  * `onVaporize()`
  * `onCondense()`

... along with the following helper methods:

  * `fsm.is(s)`            - return true if state `s` is the current state
  * `fsm.can(t)`           - return true if transition `t` can occur from the current state
  * `fsm.cannot(t)`        - return true if transition `t` cannot occur from the current state
  * `fsm.transitions()`    - return list of transitions that are allowed from the current state
  * `fsm.allTransitions()` - return list of all possible transitions
  * `fsm.allStates()`      - return list of all possible states

  ### Terminology

A state machine consists of a set of [**States**](docs/states-and-transitions.md)

  * solid
  * liquid
  * gas

A state machine changes state by using [**Transitions**](docs/states-and-transitions.md)

  * melt
  * freeze
  * vaporize
  * condense

A state machine can perform actions during a transition by observing [**Lifecycle Events**](docs/lifecycle-events.md)

  * onBeforeMelt
  * onAfterMelt
  * onLeaveSolid
  * onEnterLiquid
  * ...

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