# toolFunc

**Repository Path**: funren/tool-func

## Basic Information

- **Project Name**: toolFunc
- **Description**: 常用工具函数
- **Primary Language**: Unknown
- **License**: ISC
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-04-21
- **Last Updated**: 2021-12-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: JavaScript

## README

<!--
 * @Author: Funren
 * @Date: 2020-02LastEditTime-08 10:48:33
 * @LastEditTime: 2021-04-08 14:06:39
 * @LastEditors: Please set LastEditors
 * @Description: 工具函数
 * @FilePath: \webpack-app-base\README.md
-->

# 常用工具函数

| Name | Description |
| ----------------- | ---------------------------- |
| timeStamp         | 时间戳格式转换               |
| totalPage         | 分页计算                     |
| urlParamAdd       | url参数封装                  |
| urlParamGet       | 获取url参数                  |
| cookieAdd         | 新增cookie值                 |
| cookieGet         | 获取cookie值                 |
| sessionStorageAdd | 存储sessionStorage值             |
| sessionStorageGet | 获取sessionStorage值         |
| localStorageAdd   | 存储localStorage值           |
| localStorageGet   | 获取localStorage值           |
| strJoin           | 自定义连接符拼接字符串       |
| strTrim           | 清除字符串空格               |
| strDelRight       | 删除右侧字符串               |
| lengthRange       | 验证字符串长度是否在规定范围 |
| letterBegin       | 验证字符串是否以字母开头     |
| pureNum           | 验证字符串是否为纯数字       |
| isTest            | 判断当前处于测试模式         |
| isWeixin          | 判断微信端                   |
| isMobile          | 判断移动端                   |
| isApple           | 判断苹果移动端               |
| isAndroid         | 判断安卓移动端               |
| isMail            | 验证国内邮政编码             |
| isIdCard          | 验证二代身份证               |
| isURL             | 验证网址                     |
| isQQ              | 验证QQ号                     |
| isEmail           | 验证电子邮箱                 |
| isPhone           | 验证手机号                   |
| haveSpace         | 判断字符串是否包含空格       |
| haveCNChars       | 判断字符串是否包含中文       |



# 使用方式一

* 安装npm包

```
npm install @funren/tool-func
```

```
const $tf = require('@funren/tool-func')
$tf.isWeixin()
```



# 使用方式二

* <script></script>方式引入

```
<script src=dist/toolFunc/toolFunc.js></script>

<script>
    console.log($tf.isWeixin())
</script>
```



# 工具函数目录

<a name="cookieAdd"></a>

## cookieAdd([datas])
**新增cookie;支持以json字符串形式传入多个cookie值；**

**Kind**: global function  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [datas] | <code>Json</code> | <code>{}</code> | cookie名和值 |

**Example**  
```js
cookieAdd({
  name:'Tom',
  age:18
})
```
<a name="cookieGet"></a>

## cookieGet([cookieName]) ⇒
**获取cookie值；默认以json数组格式返回所有cookie；也可获取指定cookie值**

**Kind**: global function  
**Returns**: cookie值  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [cookieName] | <code>string</code> | <code>&quot;&#x27;all&#x27;&quot;</code> | cookie名 |

**Example**  
```js
cookieGet()
// return {name:'tom',age:'18'}
```
**Example**  
```js
cookieGet('name')
// return 'tom'
```
<a name="isAndroid"></a>

## isAndroid() ⇒
**判断是否为安卓设备**

**Kind**: global function  
**Returns**: Boolean  
<a name="isApple"></a>

## isApple() ⇒
**判断苹果移动设备**

**Kind**: global function  
**Returns**: Boolean  
<a name="isMobile"></a>

## isMobile() ⇒
判断是否为移动端设备访问

**Kind**: global function  
**Returns**: Boolean  
<a name="isTest"></a>

## isTest() ⇒
**判断开发测试环境；（方便外网测试及输出）**

**Kind**: global function  
**Returns**: Boolean；当url参数中isTest为true或1时返回true；  
<a name="isWeixin"></a>

## isWeixin() ⇒
**判断微信端**

**Kind**: global function  
**Returns**: Boolean  
<a name="localStorageAdd"></a>

## localStorageAdd(obj)
**存储本地数据；（可存储多个数据，支持对象存储；）**

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| obj | <code>json</code> | 接收json对象格式的数据 |

**Example**  
```js
let opt={
   uid:'01',
   userInfo:{ //以对象方式存储
      name:'Tom',
      age:18
   }
}
localStorageAdd(opt)
```
<a name="localStorageGet"></a>

## localStorageGet(dataName) ⇒
获取localStorage值；可以使用'.'多级链式查询,如：userInfo.name;

**Kind**: global function  
**Returns**: 参数值/undefined  

| Param | Type | Description |
| --- | --- | --- |
| dataName | <code>String</code> | 需要获取的参数名 |

**Example**  
```js
let obj={
   uid:'001',
   userInfo:{
      name:'tom',
      age:'18',
   }
}

localStorageGet('uid')
//return 001

// 多级参数名链式查找
localStorageGet('userInfo.age')
//return 18
```
<a name="sessionStorageAdd"></a>

## sessionStorageAdd(obj)
**存储窗口数据；（可存储多个数据，支持对象存储；）**

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| obj | <code>Json</code> | 接收json对象格式的数据 |

**Example**  
```js
let opt={
   uid:'01',
   userInfo:{ //以对象方式存储
      name:'Tom',
      age:18
   }
}
sessionStorageAdd(opt)
```
<a name="sessionStorageGet"></a>

## sessionStorageGet(dataName) ⇒
获取sessionStorage值；可以使用'.'多级链式查询,如：userInfo.name;

**Kind**: global function  
**Returns**: 查询参数值/undefined  

| Param | Type | Description |
| --- | --- | --- |
| dataName | <code>String</code> | 需要获取的参数名 |

**Example**  
```js
let obj={
   uid:'001',
   userInfo:{
      name:'tom',
      age:'18',
   }
}

sessionStorageGet('uid')
//return 001

// 多级参数名链式查找
sessionStorageGet('userInfo.age')
//return 18
```
<a name="strDelRight"></a>

## strDelRight(string, [number]) ⇒
**删除字符串右侧**

**Kind**: global function  
**Returns**: 新字符串  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| string | <code>String</code> |  | 必须，需要处理的字符串 |
| [number] | <code>Number</code> | <code>1</code> | 需要删除右侧的几位 |

<a name="haveSpace"></a>

## haveSpace(str) ⇒
**判断字符串是否包含空格**

**Kind**: global function  
**Returns**: Boolean  

| Param | Type |
| --- | --- |
| str | <code>String</code> | 

<a name="haveCNChars"></a>

## haveCNChars(str) ⇒
**判断字符串是否包含中文**

**Kind**: global function  
**Returns**: Boolean  

| Param | Type |
| --- | --- |
| str | <code>String</code> | 

<a name="strJoin"></a>

## strJoin([arr], [string]) ⇒
**自定义连接符拼接字符串**

**Kind**: global function  
**Returns**: 返回拼接完成后的字符串  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [arr] | <code>Array</code> |  | 需要拼接的字符串数组 |
| [string] | <code>String</code> | <code></code> | 连接符 |

**Example**  
```js
strJoin(['a','b','c'],'-')
//return a-b-c
```
<a name="strTrim"></a>

## strTrim(str, [type]) ⇒
**字符串空格处理**

**Kind**: global function  
**Returns**: 字符串  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| str | <code>String</code> |  | 需处理的字符串 |
| [type] | <code>&#x27;middle&#x27;</code> \| <code>&#x27;left&#x27;</code> \| <code>&#x27;right&#x27;</code> \| <code>&#x27;all&#x27;</code> | <code>&#x27;middle&#x27;</code> | type 类型 |

**Example**  
```js
let str=' 8 8 ';

strTrim(str);
//8 8清除了左右空格

strTrim(str,'all');
//88清除全部空格

strTrim(str,'left');
//8 8 清除左侧空格

strTrim(str,'right');
// 8 8清除了右侧空格
```
<a name="lengthRange"></a>

## lengthRange(value, minLength, maxLength) ⇒
**验证字符串长度范围**

**Kind**: global function  
**Returns**: Boolean  

| Param | Type | Description |
| --- | --- | --- |
| value | <code>String</code> |  |
| minLength | <code>Number</code> | 最小长度 |
| maxLength | <code>Number</code> | 最大长度 |

**Example**  
```js
let str='ab'
lengthRange(str,1,2)
```
<a name="letterBegin"></a>

## letterBegin(value) ⇒
**验证字符串是否以字母开头**

**Kind**: global function  
**Returns**: Boolean  

| Param | Type |
| --- | --- |
| value | <code>String</code> | 

<a name="pureNum"></a>

## pureNum(value) ⇒
**验证字符串是否为纯数字**

**Kind**: global function  
**Returns**: Boolean  

| Param | Type |
| --- | --- |
| value | <code>String</code> | 

<a name="isMail"></a>

## isMail(value) ⇒
**验证大陆邮政编码**

**Kind**: global function  
**Returns**: Boolean  

| Param | Type |
| --- | --- |
| value | <code>String</code> | 

<a name="isIdCard"></a>

## isIdCard(value) ⇒
**验证二代身份证；共18位，最后一位可为x**

**Kind**: global function  
**Returns**: Boolean  

| Param | Type |
| --- | --- |
| value | <code>String</code> | 

<a name="isURL"></a>

## isURL(value) ⇒
**验证是否为网址**

**Kind**: global function  
**Returns**: Boolean  

| Param | Type |
| --- | --- |
| value | <code>String</code> | 

<a name="isQQ"></a>

## isQQ(value) ⇒
**验证QQ号；非0开头的5~13位整数**

**Kind**: global function  
**Returns**: Boolean  

| Param | Type |
| --- | --- |
| value | <code>String</code> | 

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

## isEmail(value) ⇒
**验证电子邮箱**

**Kind**: global function  
**Returns**: Boolean  

| Param | Type |
| --- | --- |
| value | <code>String</code> | 

<a name="isPhone"></a>

## isPhone(value) ⇒
**验证手机号**

**Kind**: global function  
**Returns**: Boolean  

| Param | Type |
| --- | --- |
| value | <code>String</code> | 

<a name="isTel"></a>

## isTel(value) ⇒
**验证电话号码**

**Kind**: global function  
**Returns**: Boolean  

| Param | Type |
| --- | --- |
| value | <code>String</code> | 

<a name="timeStamp"></a>

## timeStamp([time], [type], [separator]) ⇒
**将时间戳转换成自定义格式**

**Kind**: global function  
**Returns**: -返回自定义日期  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [time] | <code>Number</code> |  | 时间戳 |
| [type] | <code>String</code> | <code>all</code> | 自定义输出格式，年、月、日、时、分、秒（n、y、r、s、f、m）；默认all输出所有； |
| [separator] | <code>String</code> | <code></code> | 自定义连接符 |

**Example** *(年-月-日)*  
```js
timeStamp(1618298335,'nyr','-')
//return 2020-01-02
```
**Example** *(年、月、日、时、分、秒可任意组合)*  
```js
timeStamp(1618298335,'nr','|')
//return 2020|02
```
<a name="totalPage"></a>

## totalPage(total, pageNum) ⇒
**分页计算；通过数据总条数与每页显示数据数量计算出总页数；**

**Kind**: global function  
**Returns**: 返回计算出的总页数  

| Param | Type | Description |
| --- | --- | --- |
| total | <code>Number</code> | 数据总条数 |
| pageNum | <code>Number</code> | 每页显示几条数据 |

<a name="urlParamAdd"></a>

## urlParamAdd([datas], [url]) ⇒
**url参数封装(可添加多个)；支持中文字符串传参，输出base-64编码字符串**

**Kind**: global function  
**Returns**: 返回参数组合，如：name='tom'&age=18  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [datas] | <code>Json</code> | <code>{}</code> | url参数 |
| [url] | <code>String</code> | <code>&#x27;&#x27;</code> | 需要拼接的域名 |

**Example**  
```js
urlParamAdd({
   name:'tom',
   age:18
})

//return bmFtZSUzRCVFNSVCQyVBMCVFNCVCOCU4OSUyNmFnZSUzRDIw
```
**Example**  
```js
* urlParamAdd({
   name:'tom',
   age:18
},'http://localhost:8080')

//return http://localhost:8080?bmFtZSUzRCVFNSVCQyVBMCVFNCVCOCU4OSUyNmFnZSUzRDIw
```
<a name="urlParamGet"></a>

## urlParamGet([paramName]) ⇒
**获取url中参数，可解码URI和base-64**

**Kind**: global function  
**Returns**: 默认返回所有url参数，指定获取参数后则返回指定参数  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [paramName] | <code>string</code> | <code>&quot;&#x27;all&#x27;&quot;</code> | 默认获取url中所有参数，也可指定获取url中某个参数 |

**Example**  
```js
url='http://localhost:8080/?name=tom&age=18';

urlParamGet()
// return {name:'tom',age:'18'}

urlParamGet('name')
// return 'tom'
```