# lgr-tools

**Repository Path**: Jerry-bro/lgr-tools

## Basic Information

- **Project Name**: lgr-tools
- **Description**: 前端工具函数库
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-05-20
- **Last Updated**: 2021-08-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# lgr-tools

## 介绍

一款自建的 `JavaScript` 工具函数库

## 安装

```bash
yarn add lgr-tools -S
# 或者
npm i lgr-tools -S
```

## 使用

```js
import { checkCommonMobile } from 'lgr-tools'

checkCommonMobile(13966992456)
```

或者

```js
const lgrTools = require('lgr-tools')

lgrTools.checkCommonMobile(13966992456)
```

## 第三方库的使用

### dayjs

用法同[dayjs](https://day.js.org/docs/zh-CN/display/format)一样

```js
import { dayjs } from 'lgr-tools'

const year = dayjs().isoWeekYear()
const info = `
当前是${year}年，
${dayjs().isLeapYear() ? '闰年' : '平年'}，
当前的时间是${dayjs().format('YYYY-MM-DD HH:mm:ss')}，
根据ISO week标准，${year}年有${dayjs().isoWeeksInYear()}个周，${dayjs().format('YYYY-MM-DD')}是第${dayjs().isoWeek()}周中的第${dayjs().isoWeekday()}天
`
console.log(info)
```

> 注意，暂时只支持`dayOfYear`、`isoWeeksInYear`、`isLeapYear`、`isoWeek`几个插件

## 方法

### 树形操作

- 平铺树形结构[treeToList()](./src/tree.js)
- 为树形结构设置层级[arrayTreeSetLevel()](./src/tree.js)

### 数组

- 深克隆 [deepClone()](./src/array.js)
- 数组去重 [unique()](./src/array.js)
- 数组对象递归平铺 [getNodeChild()](./src/array.js)

### 校验

- 校验1开头的11位手机号码 [checkCommonMobile()](./src/check.js)
- 手机号码正则 [checkMobile()](./src/check.js)
- 15位和18位身份证号码验证 [checkID()](./src/check.js)
- 去字符串的首尾空格 [trim()](./src/check.js)
- 判断移动端还是PC端 [browserAndMobile()](./src/check.js)
- 是否微信端 [isWeixin()](./src/check.js)
- 是否微博 [isWeiBo](./src/check.js)
- 是否`QQ` [isQQ()](./src/check.js)
- 是否`iPhone` [isIphone()](./src/check.js)
- 是否`Android` [isAndroid()](./src/check.js)
- 判断一个对象是否是空对象 [isEmptyObject()](./src/check.js)

### cookie操作

- 根据`name`读取`Cookie` [getCookie()](./src/cookie.js)
- 设置`Cookie` [setCookie()](./src/cookie.js)
- 根据`name`删除`Cookie` [removeCookie()](./src/cookie.js)

### 日期

- 获取某年某个月的最后一天 [getMonthLastDay()](./src/date.js)

### 节流防抖

- 防抖 [debounce()](./src/debounce_throttle.js)
- 节流 [throttle()](./src/debounce_throttle.js)

### DOM操作

- 是否有某个`class` [hasClass()](./src/dom.js)
- 添加`class` [addClass()](./src/dom.js)
- 移除`class` [removeClass()](./src/dom.js)

### 业务工具函数库

- 根据图片的`url`下载图片 [downLoadImgByUrl()](./src/business.js)
- 二进制流文件`excel`下载 [downLoadFile()](./src/business.js)
- 生成`uuid` [uuid()](./src/business.js)
- 手机号码脱敏`phoneEncrypt`[phoneEncrypt()](./src/business.js)