# 指南

# 介绍

yypkg是一个实用的JavaScript工具函数集合，快速处理各种常见的通用性问题。使用极其简单，支持整体引入和模块化引入。

# 文档

# 安装

yarn add yypkg

# or

npm i yypkg

# 使用

# 简单使用

import { sleep } from 'yypkg'

// 等待1秒
await sleep(1000)

# Tree-Shaking

import sleep from 'yypkg/sleep'

// 等待1秒
await sleep(1000)

通过该方式引入模块，可大大减少引用体积。

# API 目录

通用 Common

api 基于 axios 的 API 管理模块， 👉去使用
debounce 函数去抖， 👉去使用
throttle 函数节流， 👉去使用
sleep Promise 版的 setTimeout， 👉去使用
clone 深拷贝， 👉去使用
deepMerge 深度合并对象， 👉去使用
type 准确的类型检测， 👉去使用

路径 URL

getUrlParam 获取 URL 上参数， 👉去使用
setUrlParam 设置/追加 URL 参数， 👉去使用
removeUrlParam 移除 URL 上指定参数， 👉去使用
getUrlPath 获取当前 URL 路径（不带参数），👉去使用
getAbsoluteUrl 获取 URL 绝对路径， 👉去使用

浏览器 Browser

getUserAgent 获取浏览器用户代理字符串， 👉去使用
getFirstBrowserLanguage 获取浏览器第一语言， 👉去使用
getIEVersion 获取 IE 浏览器版本号， 👉去使用
getVendor 获取浏览器供应商的名称， 👉去使用

格式化 Format

createUUID 生成唯一标识码， 👉去使用
randomColor 生成随机颜色值， 👉去使用
trimSpace 字符串裁去空格， 👉去使用
dateFormat 简单格式化日期， 👉去使用
thousandsDot 千分位逗号， 👉去使用
padZero 前缀补充零位， 👉去使用
numberRange 设置数值范围并返回结果， 👉去使用
compareVersion 简单对比版本号， 👉去使用
stringToDOMElement 原生字符串转为 DOM 元素， 👉去使用

微信 WeChat

wechatSDK 微信 JS SDK， 👉去使用
wechatResetFontSize 微信重置字体大小（禁用字体缩放）， 👉去使用

资源 Resources

loadScript 动态加载 JS 脚本， 👉去使用
loadStyle 动态加载 Style 样式， 👉去使用
loadStyleText CSS 文本插入文档 Style 元素， 👉去使用
SourceLoader 资源加载器， 👉去使用
ProgressController 进度控制器， 👉去使用
mocha Mocha 测试， 👉去使用

检测 Detect

isWechatBrowser 判断是否为微信浏览器， 👉去使用
isQQBrowser 判断是否为 QQ 浏览器， 👉去使用
isWeiboBrowser 判断是否为微博浏览器， 👉去使用
isAndroid 判断是否为安卓设备， 👉去使用
isAndroidPhone 判断是否为安卓手机， 👉去使用
isAndroidTablet 判断是否为安卓平板， 👉去使用
isiOS 判断是否为 iOS 设备， 👉去使用
isiPhone 判断是否为 iPhone， 👉去使用
isiPhoneX 判断是否为 iPhoneX+， 👉去使用
isiPad 判断是否为 iPad， 👉去使用
isiPod 判断是否为 iPod， 👉去使用
isBlackberry 判断是否为黑莓设备， 👉去使用
isMobile 判断是否为手机设备， 👉去使用
isTablet 判断是否为平板设备， 👉去使用
isWindowsPhone 判断是否为 Windows 手机， 👉去使用
isWindowsTablet 判断是否为 Windows 平板， 👉去使用
isWindows 判断是否为 Windows 设备， 👉去使用
isChrome判断是否为 Chrome 浏览器， 👉去使用
isEdge 判断是否为 Edge 浏览器， 👉去使用
isIE 判断是否为 IE 浏览器， 👉去使用
isSafari 判断是否为 Safari 浏览器， 👉去使用

交互 UX

scrollToTop 滑动返回顶部， 👉去使用
Tween 线性运动函数， 👉去使用
appCall 唤起 APP 客户端， 👉去使用

# 更新日志

# 许可