根目录下执行 npm run build（基于 tsup），产出 dist/：真 ESM（index.mjs）+ CJS（index.js）+ 类型声明。发布前必须构建。

安装

npm i @yyzz/a-tools

导入(commonjs导入)

方式一：在commonjs中，你可以通过require方式导入
const aTools = require('@yyzz/a-tools')

方式二：es6及以上版本中，你可以通过import方式导入
import Atools from '@yyzz/a-tools'

一.html相关方法

| 方法名 | 描述 | 参数 | 例子 | | --------- | ----------------------------------------- | -------------------------------------- | -------------------------------------------- | ------------------------------------------- | | htmlToStr | 将带有 html标签的字符串 转化成 安全字符串 | noSafeStr:不安全的带有html标签的字符串 | const safeStr = aTools.htmlToStr(noSafeStr); | | strToHtml | 还原成 带有html标签的字符串 | safeStr | aTools.strToHtml(safeStr) | const noSafeStr = aTools.strToHtml(safeStr) |

二.数字相关方法

| 方法名 | 描述 | 参数 | 例子 | | ------- | -------------------- | ------------------------------------------------------------------------------------ | --------------------------------------- | | cal | js中加减乘除 | num1-数字1operationSymbol-运算符(+-*/)num2-数字2 | aTools.cal(1.2, '-', 1.1); // 结果：0.1 | | toFixed | js中需要格式化的数字 | number-需要格式化的数字decimals-保留的小数位(默认为0)isFillZero-是否需要补零 | aTools.toFixed(4.615, 2); // 结果：4.62 |

三.time时间相关方法

| 方法名 | 描述 | 参数 | 例子 | | -------------- | ------------ | ----------------------------------------------------------------------- | ------------------------------------------------------------ | | getTime | 获取当前时间 | 无 | aTools.getTime(); | | dateTimeFormat | 格式化时间 | value-时间戳/时间对象dateFormat-年月日格式timeFormat-时分秒格式 | aTools.dateTimeFormat(new Date(), 'yyyy-MM-dd', 'HH:mm:ss'); |

四.正则验证相关方法(返回值为true/false)

| 方法名 | 描述 | 参数 | 例子 | | ------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------- | | isEmpty | 检测字符串是否为空,可验证('',null,undefined) | str-待检验的字符串 | aTools.isEmpty(str) | | regular | 验证各种常用的正则 | regStr-可选类型 可选值： number:数字； numberZ:正数字； numberF:负数字； phoneNumber:手机号码，共11位，第二位可以为3456789； telephoneNumber:电话号码； identityCardNumber:身份证号码； chinese:中文； email:邮箱； domainName:域名； InternetURL:网路地址；str-待检验的字符串 | aTools.isEmpty(regStr,str) |

五.通用方法

| 方法名 | 描述 | 参数 | 例子 | | -------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | jsonToFormData | 将json对象转化成FormData对象 | json对象 | aTools.jsonToFormData({ name: 'tom', age: 12 }) | | isPC | 判断设备是否是pc端 | 无参数 | aTools.isPC() | | buildTree | 树型结构数据通用方法 | data-数组类型的数据 options-配置对象,默认值{idKey: 'id', parentIdKey: 'parentId', childrenKey: 'children'}，idKey为每条数据的唯一值,默认为id，parentIdKey为父节点,默认为parentId，childrenKey为子节点,默认为children | const tree = aTools.buildTree([{ key: 1, parentId: null, name: '111' }, { key: 7, parentId: 5, name: '777' }, { key: 2, parentId: 1, name: '222' }, { key: 3, parentId: null, name: '333' }, { key: 4, parentId: 3, name: '444' }, { key: 5, parentId: 3, name: '555' }, { key: 6, parentId: 5, name: '666' }], {idKey: 'key',parentIdKey: 'parentId',childrenKey: 'childrenArr'}) | | arrSortFun | 根据特定语言环境排序 | arr-待排序的数组 options-配置项 | const arr = aTools.arrSortFun(['a-3','a-2','a-6','a-4','a-5',], {order:'desc'}) |

开源协议

MIT