# tyutil

**Repository Path**: Alibb01/tyutil

## Basic Information

- **Project Name**: tyutil
- **Description**: js工具库，常用函数封装
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 4
- **Created**: 2019-04-11
- **Last Updated**: 2021-03-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# tyutil 

[![npm package](https://img.shields.io/badge/tyutil-0.1.1%20-green.svg)](https://www.npmjs.com/package/tyutil)

## 一个js工具库

整理了平常项目中常用的一些方法，正则验证，日期处理，金额处理，字符串处理判断，节流防抖等。

# 安装使用
### 1. npm完整引入  
`npm install tyutil --save-dev`

支持umd规范
```js
let tyutil = require('tyutil')
let mValue = tyutil.money.toBig(12345)
// mValue : 壹万贰仟叁佰肆拾伍元整
```
### 2. 部分引入  
你可以只引入你需要的模块
```js
// let date = require('tyutil/module/模块名')
let date = require('tyutil/module/date')
let fTime = date.format(new Date(),'yyyy年MM月dd日')
// fTime : 2017年12月06日
```
### 3. 浏览器
直接下载`dist`目录下的`tyutil.min.js`使用
```html
<script src="tyutil.min.js"></script>
<script>
var nowTime = tyutil.date.getTime();
</script>
```


# 模块
- common.js     封装了一些常用的函数
- date.js       日期处理
- dom.js        常用dom处理
- drawCircle.js 绘制动态环形进度条
- money.js      金额处理
- optimize.js   性能优化
- store.js      封装了sessionStorage/localStorage/cookie，方便操作
- regexp.js     一些常用的正则表达式

# API文档
## Members

<dl>
<dt><a href="#Regexp">Regexp</a></dt>
<dd><p>正则表达式封装</p>
</dd>
<dt><a href="#sstore">sstore</a></dt>
<dd><p>sessionStorage封装</p>
</dd>
<dt><a href="#lstore">lstore</a></dt>
<dd><p>localStorage封装</p>
</dd>
<dt><a href="#cookie">cookie</a></dt>
<dd><p>cookie封装</p>
</dd>
</dl>

## Functions

<dl>
<dt><a href="#isNotEmpty">isNotEmpty(str)</a> ⇒ <code>boolean</code></dt>
<dd><p>判断字符串是否不为空</p>
</dd>
<dt><a href="#isEmptyObject">isEmptyObject(obj)</a> ⇒ <code>boolean</code></dt>
<dd><p>判断对象是否为空</p>
</dd>
<dt><a href="#isNumber">isNumber(n)</a> ⇒ <code>boolean</code></dt>
<dd><p>判断是否是数字</p>
</dd>
<dt><a href="#isArray">isArray(obj)</a> ⇒ <code>void</code></dt>
<dd><p>判断是否是数组</p>
</dd>
<dt><a href="#clone">clone(obj)</a> ⇒ <code>object</code></dt>
<dd><p>克隆对象</p>
</dd>
<dt><a href="#getOS">getOS()</a> ⇒ <code>string</code></dt>
<dd><p>获取操作系统</p>
</dd>
<dt><a href="#getExplore">getExplore(versions)</a> ⇒ <code>string</code></dt>
<dd><p>获取浏览器类型和版本</p>
</dd>
<dt><a href="#urlParamsToObj">urlParamsToObj(url)</a> ⇒ <code>object</code></dt>
<dd><p>url参数转对象</p>
</dd>
<dt><a href="#objToUrlParams">objToUrlParams(url, params)</a> ⇒ <code>string</code></dt>
<dd><p>对象参数添加到url上</p>
</dd>
<dt><a href="#getParame">getParame(name)</a> ⇒ <code>string</code></dt>
<dd><p>获取url参数</p>
</dd>
<dt><a href="#randomWord">randomWord(flag, min, max)</a> ⇒ <code>string</code></dt>
<dd><p>生成任意长度随机字母数字组合</p>
</dd>
<dt><a href="#UUID">UUID()</a> ⇒ <code>string</code></dt>
<dd><p>生成uuid</p>
</dd>
<dt><a href="#ImgToBase64">ImgToBase64(url, callback, outputFormat)</a> ⇒ <code>void</code></dt>
<dd><p>img转base64</p>
</dd>
<dt><a href="#getTime">getTime()</a> ⇒ <code>number</code></dt>
<dd><p>获取当前时间戳</p>
</dd>
<dt><a href="#passedTime">passedTime(startTime)</a> ⇒ <code>string</code></dt>
<dd><p>距现在的已过时间</p>
</dd>
<dt><a href="#remainTime">remainTime(endTime)</a> ⇒ <code>string</code></dt>
<dd><p>距现在的剩余时间</p>
</dd>
<dt><a href="#format">format(dateTime, fmt)</a> ⇒ <code>string</code></dt>
<dd><p>格式化日期</p>
</dd>
<dt><a href="#strToDate">strToDate(dateStr)</a> ⇒ <code>Date</code> | <code>&#x27;&#x27;</code></dt>
<dd><p>字符串转日期</p>
</dd>
<dt><a href="#compareDate">compareDate(d1, d2)</a> ⇒ <code>number</code></dt>
<dd><p>比较两个日期</p>
</dd>
<dt><a href="#addDay">addDay(date, dayNum)</a> ⇒ <code>Date</code></dt>
<dd><p>日期添加天数</p>
</dd>
<dt><a href="#hasClass">hasClass(ele, cls)</a> ⇒ <code>boolean</code></dt>
<dd><p>是否有指定样式</p>
</dd>
<dt><a href="#addClass">addClass(ele, cls)</a> ⇒ <code>void</code></dt>
<dd><p>为指定的dom元素添加样式</p>
</dd>
<dt><a href="#removeClass">removeClass(ele, cls)</a> ⇒ <code>void</code></dt>
<dd><p>删除指定dom元素的样式</p>
</dd>
<dt><a href="#toggleClass">toggleClass(ele, cls)</a> ⇒ <code>void</code></dt>
<dd><p>如果存在(不存在)，就删除(添加)一个样式</p>
</dd>
<dt><a href="#getScrollTop">getScrollTop()</a> ⇒ <code>number</code></dt>
<dd><p>获取滚动条距离顶部的距离</p>
</dd>
<dt><a href="#offset">offset(ele)</a> ⇒ <code>number</code></dt>
<dd><p>获取元素的距离文档的位置</p>
</dd>
<dt><a href="#setScrollTop">setScrollTop(value)</a> ⇒ <code>void</code></dt>
<dd><p>设置滚动条距顶部的距离</p>
</dd>
<dt><a href="#smoothScroll">smoothScroll(to, duration)</a> ⇒ <code>void</code></dt>
<dd><p>平滑滚动到指定位置</p>
</dd>
<dt><a href="#pin">pin(ele)</a> ⇒ <code>void</code></dt>
<dd><p>当元素滚动到顶部时固定元素</p>
</dd>
<dt><a href="#isDOMElement">isDOMElement(obj)</a> ⇒ <code>boolean</code></dt>
<dd><p>判断是否是dom对象</p>
</dd>
<dt><a href="#drawCircle">drawCircle(el, percent, style)</a> ⇒ <code>void</code></dt>
<dd><p>绘制圆环进度条</p>
</dd>
<dt><a href="#format">format(num, precision, separator)</a> ⇒ <code>string</code></dt>
<dd><p>格式化金额</p>
</dd>
<dt><a href="#toBig">toBig(n)</a> ⇒ <code>string</code></dt>
<dd><p>金额转大写</p>
</dd>
<dt><a href="#isSupportWebP">isSupportWebP()</a> ⇒ <code>boolean</code></dt>
<dd><p>判断浏览器是否支持webP格式图片</p>
</dd>
<dt><a href="#loadWebP">loadWebP(attr)</a> ⇒ <code>void</code></dt>
<dd><p>替换webP</p>
</dd>
<dt><a href="#debounce">debounce(func, delay)</a> ⇒ <code>function</code></dt>
<dd><p>防抖动</p>
</dd>
<dt><a href="#throttle">throttle(func, delay)</a> ⇒ <code>function</code></dt>
<dd><p>节流</p>
</dd>
</dl>

<a name="Regexp"></a>

## Regexp
正则表达式封装

**Kind**: global variable

* [Regexp](#Regexp)
    * [.isEmail(str)](#Regexp.isEmail) ⇒ <code>boolean</code>
    * [.isMobilePhone(str)](#Regexp.isMobilePhone) ⇒ <code>boolean</code>
    * [.idCard(str)](#Regexp.idCard) ⇒ <code>boolean</code>
    * [.isUrl(str)](#Regexp.isUrl) ⇒ <code>boolean</code>
    * [.isDate(str)](#Regexp.isDate) ⇒ <code>boolean</code>
    * [.isIncludeCn(str)](#Regexp.isIncludeCn) ⇒ <code>boolean</code>
    * [.isUserName(str)](#Regexp.isUserName) ⇒ <code>boolean</code>

<a name="Regexp.isEmail"></a>

### Regexp.isEmail(str) ⇒ <code>boolean</code>
判断是否为邮箱地址

**Kind**: static method of [<code>Regexp</code>](#Regexp)

| Param | Type | Description |
| --- | --- | --- |
| str | <code>string</code> | 待验证字符串 |

<a name="Regexp.isMobilePhone"></a>

### Regexp.isMobilePhone(str) ⇒ <code>boolean</code>
判断是否是手机号码

**Kind**: static method of [<code>Regexp</code>](#Regexp)

| Param | Type | Description |
| --- | --- | --- |
| str | <code>string</code> | 待验证字符串 |

<a name="Regexp.idCard"></a>

### Regexp.idCard(str) ⇒ <code>boolean</code>
判断是否是身份证

**Kind**: static method of [<code>Regexp</code>](#Regexp)

| Param | Type | Description |
| --- | --- | --- |
| str | <code>string</code> | 待验证字符串 |

<a name="Regexp.isUrl"></a>

### Regexp.isUrl(str) ⇒ <code>boolean</code>
判断是否是url

**Kind**: static method of [<code>Regexp</code>](#Regexp)

| Param | Type | Description |
| --- | --- | --- |
| str | <code>string</code> | 待验证字符串 |

<a name="Regexp.isDate"></a>

### Regexp.isDate(str) ⇒ <code>boolean</code>
判断是否是日期

**Kind**: static method of [<code>Regexp</code>](#Regexp)

| Param | Type | Description |
| --- | --- | --- |
| str | <code>string</code> | 待验证字符串 |

<a name="Regexp.isIncludeCn"></a>

### Regexp.isIncludeCn(str) ⇒ <code>boolean</code>
判断是否包含中文

**Kind**: static method of [<code>Regexp</code>](#Regexp)

| Param | Type | Description |
| --- | --- | --- |
| str | <code>string</code> | 待验证字符串 |

<a name="Regexp.isUserName"></a>

### Regexp.isUserName(str) ⇒ <code>boolean</code>
判断用户名4-16位（字母，数字，下划线，减号）

**Kind**: static method of [<code>Regexp</code>](#Regexp)

| Param | Type | Description |
| --- | --- | --- |
| str | <code>string</code> | 待验证字符串 |

<a name="sstore"></a>

## sstore
sessionStorage封装

**Kind**: global variable

* [sstore](#sstore)
    * [.set(key, value)](#sstore.set) ⇒ <code>void</code>
    * [.get(key)](#sstore.get) ⇒ <code>object</code>
    * [.del(key)](#sstore.del) ⇒ <code>void</code>
    * [.clear()](#sstore.clear) ⇒ <code>void</code>

<a name="sstore.set"></a>

### sstore.set(key, value) ⇒ <code>void</code>
添加

**Kind**: static method of [<code>sstore</code>](#sstore)

| Param | Type | Description |
| --- | --- | --- |
| key | <code>string</code> | key |
| value | <code>string</code> | 值 |

<a name="sstore.get"></a>

### sstore.get(key) ⇒ <code>object</code>
获取

**Kind**: static method of [<code>sstore</code>](#sstore)

| Param | Type | Description |
| --- | --- | --- |
| key | <code>string</code> | key |

<a name="sstore.del"></a>

### sstore.del(key) ⇒ <code>void</code>
删除

**Kind**: static method of [<code>sstore</code>](#sstore)

| Param | Type | Description |
| --- | --- | --- |
| key | <code>string</code> | key |

<a name="sstore.clear"></a>

### sstore.clear() ⇒ <code>void</code>
清除

**Kind**: static method of [<code>sstore</code>](#sstore)
<a name="lstore"></a>

## lstore
localStorage封装

**Kind**: global variable

* [lstore](#lstore)
    * [.set(key, value)](#lstore.set) ⇒ <code>void</code>
    * [.get(key)](#lstore.get) ⇒ <code>object</code>
    * [.del(key)](#lstore.del) ⇒ <code>void</code>
    * [.clear()](#lstore.clear) ⇒ <code>void</code>

<a name="lstore.set"></a>

### lstore.set(key, value) ⇒ <code>void</code>
添加

**Kind**: static method of [<code>lstore</code>](#lstore)

| Param | Type | Description |
| --- | --- | --- |
| key | <code>string</code> | key |
| value | <code>object</code> | 值 |

<a name="lstore.get"></a>

### lstore.get(key) ⇒ <code>object</code>
获取

**Kind**: static method of [<code>lstore</code>](#lstore)

| Param | Description |
| --- | --- |
| key | key |

<a name="lstore.del"></a>

### lstore.del(key) ⇒ <code>void</code>
删除

**Kind**: static method of [<code>lstore</code>](#lstore)

| Param | Description |
| --- | --- |
| key | key |

<a name="lstore.clear"></a>

### lstore.clear() ⇒ <code>void</code>
清除

**Kind**: static method of [<code>lstore</code>](#lstore)
<a name="cookie"></a>

## cookie
cookie封装

**Kind**: global variable

* [cookie](#cookie)
    * [.set(key, value, time)](#cookie.set) ⇒ <code>void</code>
    * [.get(key)](#cookie.get) ⇒ <code>string</code>
    * [.del(key)](#cookie.del) ⇒ <code>void</code>

<a name="cookie.set"></a>

### cookie.set(key, value, time) ⇒ <code>void</code>
设置cookie key的值

**Kind**: static method of [<code>cookie</code>](#cookie)

| Param | Type | Description |
| --- | --- | --- |
| key | <code>string</code> | key |
| value | <code>string</code> | 值 |
| time | <code>number</code> | 失效时间 |

<a name="cookie.get"></a>

### cookie.get(key) ⇒ <code>string</code>
获取cookie指定key值

**Kind**: static method of [<code>cookie</code>](#cookie)

| Param | Type | Description |
| --- | --- | --- |
| key | <code>string</code> | key |

<a name="cookie.del"></a>

### cookie.del(key) ⇒ <code>void</code>
删除cookie

**Kind**: static method of [<code>cookie</code>](#cookie)

| Param | Type | Description |
| --- | --- | --- |
| key | <code>string</code> | key |

<a name="isNotEmpty"></a>

## isNotEmpty(str) ⇒ <code>boolean</code>
判断字符串是否不为空

**Kind**: global function

| Param | Type | Description |
| --- | --- | --- |
| str | <code>string</code> | 字符串 |

<a name="isEmptyObject"></a>

## isEmptyObject(obj) ⇒ <code>boolean</code>
判断对象是否为空

**Kind**: global function

| Param | Type |
| --- | --- |
| obj | <code>object</code> |

<a name="isNumber"></a>

## isNumber(n) ⇒ <code>boolean</code>
判断是否是数字

**Kind**: global function

| Param | Type |
| --- | --- |
| n | <code>object</code> |

<a name="isArray"></a>

## isArray(obj) ⇒ <code>void</code>
判断是否是数组

**Kind**: global function

| Param | Type |
| --- | --- |
| obj | <code>object</code> |

<a name="clone"></a>

## clone(obj) ⇒ <code>object</code>
克隆对象

**Kind**: global function

| Param | Type |
| --- | --- |
| obj | <code>object</code> |

<a name="getOS"></a>

## getOS() ⇒ <code>string</code>
获取操作系统

**Kind**: global function
<a name="getExplore"></a>

## getExplore(versions) ⇒ <code>string</code>
获取浏览器类型和版本

**Kind**: global function

| Param | Type |
| --- | --- |
| versions | <code>boolean</code> |

<a name="urlParamsToObj"></a>

## urlParamsToObj(url) ⇒ <code>object</code>
url参数转对象

**Kind**: global function

| Param | Type | Description |
| --- | --- | --- |
| url | <code>String</code> | url |

<a name="objToUrlParams"></a>

## objToUrlParams(url, params) ⇒ <code>string</code>
对象参数添加到url上

**Kind**: global function
**Returns**: <code>string</code> - url

| Param | Type | Description |
| --- | --- | --- |
| url | <code>string</code> | url |
| params | <code>object</code> | 参数 |

<a name="getParame"></a>

## getParame(name) ⇒ <code>string</code>
获取url参数

**Kind**: global function

| Param | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | 参数名 |

<a name="randomWord"></a>

## randomWord(flag, min, max) ⇒ <code>string</code>
生成任意长度随机字母数字组合

**Kind**: global function

| Param | Type | Description |
| --- | --- | --- |
| flag | <code>boolean</code> | 是否任意长度 |
| min | <code>number</code> | 最小长度 |
| max | <code>number</code> | 最大长度 |

<a name="UUID"></a>

## UUID() ⇒ <code>string</code>
生成uuid

**Kind**: global function
<a name="ImgToBase64"></a>

## ImgToBase64(url, callback, outputFormat) ⇒ <code>void</code>
img转base64

**Kind**: global function

| Param | Type |
| --- | --- |
| url | <code>string</code> |
| callback | <code>function</code> |
| outputFormat | <code>string</code> |

<a name="getTime"></a>

## getTime() ⇒ <code>number</code>
获取当前时间戳

**Kind**: global function
<a name="passedTime"></a>

## passedTime(startTime) ⇒ <code>string</code>
距现在的已过时间

**Kind**: global function

| Param | Type | Description |
| --- | --- | --- |
| startTime | <code>string</code> | 开始日期字符串 |

<a name="remainTime"></a>

## remainTime(endTime) ⇒ <code>string</code>
距现在的剩余时间

**Kind**: global function

| Param | Type | Description |
| --- | --- | --- |
| endTime | <code>string</code> | 结束日期字符串 |

<a name="format"></a>

## format(dateTime, fmt) ⇒ <code>string</code>
格式化日期

**Kind**: global function

| Param | Type | Description |
| --- | --- | --- |
| dateTime | <code>string</code> | 日期/日期字符串 |
| fmt | <code>object</code> | 格式 |

<a name="strToDate"></a>

## strToDate(dateStr) ⇒ <code>Date</code> \| <code>&#x27;&#x27;</code>
字符串转日期

**Kind**: global function

| Param | Type | Description |
| --- | --- | --- |
| dateStr | <code>string</code> | 日期字符串 |

<a name="compareDate"></a>

## compareDate(d1, d2) ⇒ <code>number</code>
比较两个日期

**Kind**: global function
**Returns**: <code>number</code> - 1:大于;0:等于;-1:小于

| Param | Type | Description |
| --- | --- | --- |
| d1 | <code>Date</code> | 第一个日期 |
| d2 | <code>Date</code> | 第二个日期 |

<a name="addDay"></a>

## addDay(date, dayNum) ⇒ <code>Date</code>
日期添加天数

**Kind**: global function

| Param | Type | Description |
| --- | --- | --- |
| date | <code>Date</code> | 日期 |
| dayNum | <code>number</code> | 添加的天数 |

<a name="hasClass"></a>

## hasClass(ele, cls) ⇒ <code>boolean</code>
是否有指定样式

**Kind**: global function

| Param | Type | Description |
| --- | --- | --- |
| ele | <code>object</code> | dom节点 |
| cls | <code>string</code> | class名称 |

<a name="addClass"></a>

## addClass(ele, cls) ⇒ <code>void</code>
为指定的dom元素添加样式

**Kind**: global function

| Param | Type | Description |
| --- | --- | --- |
| ele | <code>object</code> | dom节点 |
| cls | <code>string</code> | class名称 |

<a name="removeClass"></a>

## removeClass(ele, cls) ⇒ <code>void</code>
删除指定dom元素的样式

**Kind**: global function

| Param | Type | Description |
| --- | --- | --- |
| ele | <code>object</code> | dom节点 |
| cls | <code>string</code> | class名称 |

<a name="toggleClass"></a>

## toggleClass(ele, cls) ⇒ <code>void</code>
如果存在(不存在)，就删除(添加)一个样式

**Kind**: global function

| Param | Type | Description |
| --- | --- | --- |
| ele | <code>object</code> | dom节点 |
| cls | <code>string</code> | class名称 |

<a name="getScrollTop"></a>

## getScrollTop() ⇒ <code>number</code>
获取滚动条距离顶部的距离

**Kind**: global function
<a name="offset"></a>

## offset(ele) ⇒ <code>number</code>
获取元素的距离文档的位置

**Kind**: global function

| Param | Type | Description |
| --- | --- | --- |
| ele | <code>object</code> | dom节点 |

<a name="setScrollTop"></a>

## setScrollTop(value) ⇒ <code>void</code>
设置滚动条距顶部的距离

**Kind**: global function

| Param | Type | Description |
| --- | --- | --- |
| value | <code>number</code> | 距离 |

<a name="smoothScroll"></a>

## smoothScroll(to, duration) ⇒ <code>void</code>
平滑滚动到指定位置

**Kind**: global function

| Param | Type | Description |
| --- | --- | --- |
| to | <code>number</code> | 距离顶部的距离 |
| duration | <code>number</code> | 滚动的时间 |

<a name="pin"></a>

## pin(ele) ⇒ <code>void</code>
当元素滚动到顶部时固定元素

**Kind**: global function

| Param | Type | Description |
| --- | --- | --- |
| ele | <code>object</code> | dom节点 |

<a name="isDOMElement"></a>

## isDOMElement(obj) ⇒ <code>boolean</code>
判断是否是dom对象

**Kind**: global function

| Param | Type |
| --- | --- |
| obj | <code>object</code> |

<a name="drawCircle"></a>

## drawCircle(el, percent, style) ⇒ <code>void</code>
绘制圆环进度条

**Kind**: global function

| Param | Type | Description |
| --- | --- | --- |
| el | <code>string</code> | canvas节点 |
| percent | <code>number</code> | 进度 |
| style | <code>object</code> | 样式配置 |
| style.width | <code>number</code> | 圆环宽度 |
| style.height | <code>number</code> | 圆环高度 |
| style.bgColor | <code>string</code> | 背景圆环的颜色 |
| style.foreColor | <code>string</code> | 运动圆环的颜色 |
| style.lineWidth | <code>number</code> | 环的宽度 |
| style.fontSize | <code>number</code> | 字体大小 |
| style.fontFamily | <code>string</code> | 字体 |
| style.lineCap | <code>boolean</code> | 运动圆环是否圆角 |

<a name="format"></a>

## format(num, precision, separator) ⇒ <code>string</code>
格式化金额

**Kind**: global function

| Param | Type | Description |
| --- | --- | --- |
| num | <code>number</code> | 金额 |
| precision | <code>number</code> | 精度 |
| separator | <code>\*</code> | 分隔符 |

<a name="toBig"></a>

## toBig(n) ⇒ <code>string</code>
金额转大写

**Kind**: global function

| Param | Type | Description |
| --- | --- | --- |
| n | <code>number</code> | 金额 |

<a name="isSupportWebP"></a>

## isSupportWebP() ⇒ <code>boolean</code>
判断浏览器是否支持webP格式图片

**Kind**: global function
<a name="loadWebP"></a>

## loadWebP(attr) ⇒ <code>void</code>
替换webP

**Kind**: global function

| Param | Type |
| --- | --- |
| attr | <code>string</code> |

<a name="debounce"></a>

## debounce(func, delay) ⇒ <code>function</code>
防抖动

**Kind**: global function

| Param | Type | Description |
| --- | --- | --- |
| func | <code>function</code> | 要执行的函数 |
| delay | <code>number</code> | 间隔时间 |

<a name="throttle"></a>

## throttle(func, delay) ⇒ <code>function</code>
节流

**Kind**: global function

| Param | Type | Description |
| --- | --- | --- |
| func | <code>function</code> | 要执行的函数 |
| delay | <code>number</code> | 间隔时间 |