Skip to content

Latest commit

 

History

History
177 lines (130 loc) · 7.3 KB

README.md

File metadata and controls

177 lines (130 loc) · 7.3 KB

utilscoreJS

前端业务代码工具库(不定时更新)

目的：高效率完成前端业务代码

业务开发过程中，会经常用到String,Number,Array,Object,Function,Date,prototype扩展方法、base64、表单验证、url、事件订阅等常用函数，为避免不同项目多次复制粘贴的麻烦，这里统一封装，并发布到npm，以提高开发效率。如果你也有常用的代码，欢迎为本项目提交pr.

安装使用

  1. 直接下载 utilsocre 目录下的 index.js 使用,支持CDN,UMD,CommonJS,ES6各模块化规范。
  2. 使用npm/yarn/cnpm安装,支持CommonJS,ES6各模块化规范。

注意：原型扩展需要独立引入，utilscore/libs/prototype.js

浏览器:

<!-- cdn 体验最新版 -->
<script src="https://raw.githack.com/cgxqd/utilscore/master/index.js"></script>

<!-- 引入 node_modules/utilscore 下的 index.js -->
<!-- <script src="./node_modules/utilscore/index.js"></script> -->
<script>
	let txt = utilscore.mask('12398765432',3,7) 
	console.log(txt) // => "123****5432"
</script>

npm

$ npm i utilscore

yarn

$ yarn add utilscore

cnpm

$ cnpm i utilscore

React、VueJS,小程序等javascript环境

// 完整引入
import utilscore from 'utilscore'


// 引入原型扩展
import 'utilscore/libs/prototype.js'

let txt = utilscore.mask('12398765432',3,7) 
console.log(txt) // => "123****5432"

推荐使用方法

你真的不需要完整引入所有函数，所以只引入需要使用的方法即可。

import { mask } from 'utilscore'

let txt = mask('12398765432',3,7) 
console.log(txt) // => "123****5432"

📦 API文档

Object 示例

  • deepClone 深度克隆。
  • orderBy 返回按属性(props)和顺序(orders)排序的对象数组,用于数据排序。
  • findPathByLeafId 根据 key 递归查找链带关系。
  • merge 对象合并。
  • selector 从对象中检索出给定选择器指定的一组属性。

Array 示例

  • uniqueBy 根据属性去重数组。
  • unique 普通数组去重。
  • maxNumBy 找出数组中该属性最大值的一列。
  • minNumBy 找出数组中该属性最小值的一列。
  • maxNum 数组中的最大值。
  • mixNum 数组中的最小值。
  • shuffle 将数组打乱。
  • convert 扁平化数组 ==> 树形结构。
  • convertFlat 树形结构 ==> 扁平化。

Date 示例

  • formatTime 格式化时间。
  • formatHMS 将秒数转为 xx小时xx分钟xx秒 例如1h0m10s。

Function 示例

  • debounceStart 函数防抖 (立即执行版)。
  • debounceEnd 函数防抖 (非立即执行版)。
  • debounce 函数防抖 (完全版)。
  • throttle 函数节流。

String 示例

  • mask 根据位置,使用 * 遮蔽字符串。
  • maskLeft 从位置左边开始，使用 * 遮蔽字符串。
  • maskRight 从位置右边开始，使用 * 遮蔽字符串。
  • randomHexColorCode 生成一个随机的十六进制颜色代码。
  • getCounts 返回元素出现的次数。
  • uuid 全局唯一标识符 UUID
  • guid GUID:128位的数字标识符

Number 示例

  • randomNum 返回指定范围内的随机整数。
  • round 将数字四舍五入到指定的小数位数。
  • sum 返回两个或两个以上数字/数字数组中元素之和。
  • sumBy 根据函数映射每个元素，然后返回数组的和。
  • toDecimalMark 将数字转化为千分位格式，可以在数字前面加上符号。
  • addNum 加法运算,可浮点安全运算。
  • subNum 减法运算,可浮点安全运算。
  • mulNum 乘法运算,可浮点安全运算。
  • divNum 除法运算,可浮点安全运算。
  • getrandom 产生n个随机数,并且随机数之和是固定值

TypeOf 示例

  • isNull 判断类型Null。
  • isUndefined 判断类型Undefined。
  • isBoolean 判断类型Boolean。
  • isNumber 判断类型Number。
  • isString 判断类型String。
  • isSymbol 判断类型Symbol。
  • isObject 判断类型Object。
  • isRegExp 判断类型RegExp。
  • isArray 判断类型Array。
  • isFunction 判断类型Function。
  • isEmpty 判断元素是否为空。
  • getType 获取类型，全能型的typeOf。

url 示例

  • insertUrl 根据对象中的参数匹配插入到url中。
  • URLSearchParams url 序列化和反序列化。
  • Url 返回网址的相关信息，模拟了 浏览器的 new URL(urlString) 部分功能

validator 示例

  • graceChecker 表单验证。

base64 示例

  • encode base64加密。
  • decode base64解密。

EventEmitter 示例

  • on 为指定事件注册一个监听器。
  • once 为指定事件注册一个单次监听器。
  • emit 触发指定事件的监听器。
  • off 移除指定事件的监听器。
  • allOff 移除所有事件的所有监听器，如果指定事件，则移除指定事件的所有监听器。

prototype

  • match_all 扩展 String 的原型方法 es10 的 matchAll（未兼容浏览器）。
  • fromEntries 扩展 es10 的 Object.fromEntries() 。
  • entries 扩展 es 的 Object.entries() 。

Web Api

  • blobToDataURL 将 file、blob、stream 格式 转 DateURL。
  • dataURLtoBlob 将图片的 dataURL 转为 Blob 格式。
  • getImgToBase64 将图片的 url 转为 base64 格式。
  • getImgToBlob 将图片的 url 转为 Blob 格式。
  • downloadFile 在客户端触发文件下载。
  • setClipboardData 将文本数据放置在剪贴板上。