# fe-utils

**Repository Path**: we_coder/fe-utils

## Basic Information

- **Project Name**: fe-utils
- **Description**: 前端工具库npm包源码
- **Primary Language**: TypeScript
- **License**: EPL-1.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2021-10-08
- **Last Updated**: 2023-09-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# @fallen_leaves/fe-utils

前端通用工具库

> 优点：提高前端业务代码开发效率，增强代码复用性

前端开发过程中，会经常用到`判断浏览器类型`、`格式化各种日期`、`获取url参数`、`queryString转对象`、`防抖函数`、`节流函数`等常用函数，为避免不同项目多次复制粘贴的麻烦，这里统一封装，并发布到npm，以提高开发效率。

## 安装
```bash
  npm install --save @fallen_leaves/fe-utils
  # or
  yarn add @fallen_leaves/fe-utils
```
## 使用
```bash
  # 完整导入
  import FeUtils from '@fallen_leaves/fe-utils'

  FeUtils.getCookie('user_id')
  # or

  # 模块导入
  import { getCookie } from '@fallen_leaves/fe-utils'

  getCookie('user_id')
```

## API文档

### Color
- [hexToRGB](src/color/hexToRGB.ts)  16进制颜色值转rgb格式
- [RGBToHex](src/color/RGBToHex.ts)  16进制颜色值转rgb格式
### Cookie
- [setCookie](src/cookie/setCookie.ts)  添加cookie
- [getCookie](src/cookie/getCookie.ts)  获取cookie
- [removeCookie](src/cookie/removeCookie.ts)  删除cookie

### Device
- [getExplore](src/device/getExplore.ts)  获取浏览器型号和版本
- [getOS](src/device/getOS.ts)  获取操作系统类型
- [versionCompare](src/device/versionCompare.ts)  版本号比较
### Dom
- [useFullscreen](src/dom/useFullscreen.ts)  全屏方法及事件监听
- [useWatermark](src/dom/useWatermark.ts)  为指定元素添加水印
### Function
- [debounce](src/function/debounce.ts)  防抖函数
- [throttle](src/function/throttle.ts)  节流函数

### Number
- [digitUppercase](src/number/digitUppercase.ts)  数字转大写
- [fixedThousandsNumber](src/number/fixedThousandsNumber.ts)  数字千分位格式化
- [formatFileSize](src/number/formatFileSize.ts)  文件大小格式化

### Object
- [deepClone](src/object/deepClone.ts)  深拷贝
- [isEmpty](src/object/isEmpty.ts)  空对象判断

### Regexp
- [RegCollections](src/regexp/index.ts)  常用正则判断函数
  - .isUrl(url)  判段目标字符串是否为url
  - .isPhoneNumber(phoneNumber)  判段目标字符串是否为手机号
  - .isEmail(email)  判段目标字符串是否为邮箱
  - .isIDCard(IDCard)  判段目标字符串是否为身份证号码
  - .isZipCode(zipCode)  判段目标字符串是否为邮政编码
  - .isIE()  判段是否为IE
  - .isChrome()  判段是否为Chrome
  - .isFirefox()  判段是否为Firefox
  - .isOpera()  判段是否为Opera
  - .isSafari()  判段是否为Safari
  - .isEdge()  判段是否为Edge
  - .isAndroid()  判段是否为Android
  - .isIPhone() 判段是否为iPhone
  - .isIPad()  判段是否为iPad
  - .isMacOS()  判段是否为MacOS
  - .isWindows()  判段是否为Windows
  - .isLinux()  判段是否为Linux
  - .isWeChat()  判段是否为微信环境

### Time
- [formatFixedDate](src/time/formatFixedDate.ts)  时间对象或者时间戳格式化
- [formatPassTime](src/time/formatPassTime.ts)  距离指定时间已过去的时间格式化

### Url
- [getUrlParams](src/url/getUrlParams.ts)  获取url上的query参数
- [deleteParams](src/url/deleteParams.ts)  删除url上指定的query参数
- [parseQuery](src/url/parseQuery.ts)  querySrting格式化为对象
- [stringifyQuery](src/url/stringifyQuery.ts)  对象格式化为queryString

### String
- [urlToLink](src/string/urlToLink.ts)  目标字符串中的url串转换为<a>标签