xijs更新指南(v1.2.1)

xijs 是一款开箱即用的 js 业务工具库, 聚集于解决业务中遇到的常用函数逻辑问题, 帮助开发者更高效的开展业务开发.

接下来就和大家一起分享一下v1.2.1 版本的更新内容以及后续的更新方向.

1. 添加算法模块分类

该模块主要由 WangLei802 贡献, 添加内容如下:

• 添加冒泡排序算法及其单元测试
• 添加快速排序算法及其单元测试

使用方式如下:

1. 冒泡排序

import { bubbleSort } from 'xijs';
let arr = [1, 3, 2, 8, 4];
let objArr = [
  { name: '8', age: 18 },
  { name: '3', age: 13 },
  { name: '5', age: 15 },
  { name: '2', age: 12 },
];
// bubbleSort(arr,arrKey,orderby)  参数说明： 1、arr => 简单数组or对象数组 2、arrKey => 对象数组key 3、orderby => 排序方式（默认升序('asc')、降序（'desc'））
// 简单数组冒泡排序 --> 升序
bubbleSort(arr); // -> [1,2,3,4,8]
// 简单数组冒泡排序 --> 降序
bubbleSort(arr,'','desc'); // -> [8,4,3,2,1]
// 对象数组冒泡排序 注：默认升序
bubbleSort(objArr,'age'); // -> [{ name: '2', age: 12 },{ name: '3', age: 13 },{ name: '5', age: 15 }...]
// 对象数组冒泡排序 --> 降序
bubbleSort(objArr,'age','desc'); // -> [{ name: '8', age: 18 },{ name: '5', age: 15 },{ name: '3', age: 13 }...]

2. 快速排序

import { quickSort } from 'xijs';
let arr = [1, 3, 2, 8, 4];
let objArr = [
  { name: '8', age: 18 },
  { name: '3', age: 13 },
  { name: '5', age: 15 },
  { name: '2', age: 12 },
];
// quickSort(arr,key)  参数说明： 1、arr => 简单数组or对象数组 2、key => 可选参数对象数组key 
// 简单数组快速排序
quickSort(arr); // -> [1,2,3,4,8]
// 对象数组快速排序
quickSort(objArr,'age'); // -> [{ name: '2', age: 12 },{ name: '3', age: 13 },{ name: '5', age: 15 }...]

2. 添加几何计算模块分类

该模块主要由 EasyRo 贡献, 添加内容如下:

• coordinatesInCircle 生成圆内任意坐标
• coordinatesInRect 生成矩形内任意坐标
• judgePointInCircle 判断一点是否在圆内

这几个方法对于可视化项目的设计和开发非常有价值, 后续会在几何计算模块中开拓更多常用函数, 供大家轻松使用. 接下来介绍一下具体用法:

import { judgePointInCircle } from 'xijs';
// 判断中心在(3,4) 坐标内, 半径为5的圆上是否存在(4,6) 这个点
const res = judgePointInCircle(
  {
    center: [3, 4],
    r: 5,
  },
  4,
  6,
);
console.log(res); // -> true

该算法运用了很多几何和代数知识, 我之前在设计开源项目vue3几何画板 中也使用了大量几何判断, 感兴趣的朋友可以参考一下:

github地址: https://gitee.com/lowcode-china/euryd

接下来我们跑一下单元测试, 对整个库做一个全面的扫描:

整个测试一共花了10s, 测试全部通过, 各位小伙伴们可以放松食用.

为了方便大家更好的了解 xijs 这个库, 我列一个完整的目录结构供大家参考, 也可以直接用 xijs 的在线文档中去参考学习.

• 浏览器相关

  • getRuntimeEnv - 获取运行环境
  • getSelection - 获取选中文本
  • redirect - 重定向
  • store - 本地存储库
• 字符串操作

  • base64 - base64编码和解码
  • camelize - 横线转驼峰命名
  • charCount - 获取字符数
  • formatNumber - 数值千分位格式化
  • formatPercent - 值转换为百分数表示
  • hyCompact - 紧凑型驼峰命名转换
  • hyphenate - 驼峰命名转横线命名
  • randomStr - 生成随机字符串
  • repeat - 生成重复字符串
  • uuid - 生成唯一id
• 常用判断函数

  • isArray - 判断数组类型
  • isEmpty - 判断空对象
  • isPc - 判断设备类型
  • isPhone - 判断手机号格式
• 数据结构相关

  • cloneDeep - 数据深拷贝
  • formatDate - 时间格式化
  • getRawType - 获取数据类型
  • obj2url - 将对象参数解析为url字符串
  • transformTree - 扁平转树结构
  • url2obj - url字符串转对象
• 图片处理函数

  • compressImg - 自定义压缩图片函数
  • file2img - 文件转图片对象
  • hex2rgba - hex色值转rgba
  • rgba2obj - 将rgba值转化为rgba对象
• js高级函数

  • debounce - 防抖函数
  • parser - json超级解析器
  • sleep - 睡眠函数
  • throttle - 节流函数
• 常用算法和数据结构

  • bubbleSort - 冒泡排序
  • quickSort - 快速排序
• 数学计算

  • average - 计算数组平均值
  • difference - 创建一个排除指定项的数组
  • random - 返回区域内随机数
  • shuffle - 打乱数组
• 几何计算

  • coordinatesInCircle - 生成圆内任意坐标
  • coordinatesInRect - 生成矩形内任意坐标
  • judgePointInCircle - 判断一点是否在圆内

欢迎大家star推荐, 让前端工作更高效.

github: https://github.com/MrXujiang/xijs