a-js-tools 0.1.0 → 0.1.2

package/README.md

@@ -1,30 +1,35 @@
 # a-js-tools
 
-[![version](<https://img.shields.io/npm/v/a-js-tools.svg?logo=npm&logoColor=rgb(0,0,0)&label=version&labelColor=rgb(73,73,228)&color=rgb(0,0,0)>)](https://www.npmjs.com/package/a-js-tools) [![NPM Last Update](<https://img.shields.io/npm/last-update/a-js-tools?logo=npm&labelColor=rgb(255,36,63)&color=rgb(0,0,0)>)](https://www.npmjs.com/package/a-js-tools) [![📦 size](<https://img.shields.io/bundlephobia/minzip/a-js-tools.svg?logo=npm&labelColor=rgb(201,158,140)&color=rgb(0,0,0)>)](https://www.npmjs.com/package/a-js-tools) [![downloads](<https://img.shields.io/npm/dm/a-js-tools.svg?logo=npm&logoColor=rgb(0,0,0)&labelColor=rgb(194,112,210)&color=rgb(0,0,0)>)](https://www.npmjs.com/package/a-js-tools) [![downloads](<https://img.shields.io/npm/dt/a-js-tools.svg?logo=npm&labelColor=rgb(107,187,124)&color=rgb(0,0,0)>)](https://www.npmjs.com/package/a-js-tools)
+[![version](<https://img.shields.io/npm/v/a-js-tools.svg?logo=npm&logoColor=rgb(0,0,0)&label=版本号&labelColor=rgb(73,73,228)&color=rgb(0,0,0)>)](https://www.npmjs.com/package/a-js-tools) [![NPM Last Update](<https://img.shields.io/npm/last-update/a-js-tools?logo=npm&label=版本最后更新&labelColor=rgb(255,36,63)&color=rgb(0,0,0)>)](https://www.npmjs.com/package/a-js-tools) [![📦 size](<https://img.shields.io/bundlephobia/minzip/a-js-tools.svg?logo=npm&label=压缩包大小&labelColor=rgb(201,158,140)&color=rgb(0,0,0)>)](https://www.npmjs.com/package/a-js-tools) [![downloads](<https://img.shields.io/npm/dm/a-js-tools.svg?logo=npm&logoColor=rgb(0,0,0)&label=月下载量&labelColor=rgb(194,112,210)&color=rgb(0,0,0)>)](https://www.npmjs.com/package/a-js-tools) [![downloads](<https://img.shields.io/npm/dt/a-js-tools.svg?logo=npm&label=总下载量&labelColor=rgb(107,187,124)&color=rgb(0,0,0)>)](https://www.npmjs.com/package/a-js-tools)
 
-[![last commit](<https://img.shields.io/github/last-commit/earthnutDev/a-js-tools.svg?logo=github&logoColor=rgb(0,0,0)&labelColor=rgb(255,165,0)&color=rgb(0,0,0)>)](https://github.com/earthnutDev/a-js-tools) [![GitHub commit activity](<https://img.shields.io/github/commit-activity/y/earthnutDev/a-js-tools.svg?logo=github&labelColor=rgb(128,0,128)&color=rgb(0,0,0)>)](https://github.com/earthnutDev/a-js-tools) [![Coverage Status](<https://img.shields.io/coverallsCoverage/github/earthnutDev/a-js-tools?logo=coveralls&label=coveralls&labelColor=rgb(12, 244, 39)&color=rgb(0,0,0)>)](https://coveralls.io/github/earthnutDev/a-js-tools?branch=main) [![codecov](<https://img.shields.io/codecov/c/github/earthnutDev/a-js-tools/main?logo=codecov&label=codecov&labelColor=rgb(7, 245, 245)&color=rgb(0,0,0)>)](https://codecov.io/gh/earthnutDev/a-js-tools)
+[![last commit](<https://img.shields.io/github/last-commit/earthnutDev/a-js-tools.svg?logo=github&logoColor=rgb(0,0,0)&label=最后推码&labelColor=rgb(255,165,0)&color=rgb(0,0,0)>)](https://github.com/earthnutDev/a-js-tools) [![GitHub commit activity](<https://img.shields.io/github/commit-activity/y/earthnutDev/a-js-tools.svg?logo=github&label=推码数&labelColor=rgb(128,0,128)&color=rgb(0,0,0)>)](https://github.com/earthnutDev/a-js-tools) [![Coverage Status](<https://img.shields.io/coverallsCoverage/github/earthnutDev/a-js-tools?logo=coveralls&label=coveralls&labelColor=rgb(12, 244, 39)&color=rgb(0,0,0)>)](https://coveralls.io/github/earthnutDev/a-js-tools?branch=main) [![codecov](<https://img.shields.io/codecov/c/github/earthnutDev/a-js-tools/main?logo=codecov&label=codecov&labelColor=rgb(7, 245, 245)&color=rgb(0,0,0)>)](https://codecov.io/gh/earthnutDev/a-js-tools)
 
 ---
 
-[![🇨🇳 中文](<https://img.shields.io/badge/🇨🇳-中_%20_文-rgb(0,0,0)>)](https://github.com/earthnutDev/a-js-tools/blob/main/README-zh.md) ![🌍 English](<https://img.shields.io/badge/🌍-English-rgb(0,0,0)?style=social>) [![👀 change log](<https://img.shields.io/badge/👀-change_%20_log-rgb(0,125,206)?logo=github>)](https://github.com/earthnutDev/a-js-tools/blob/main/CHANGELOG-en.md) [![submit 🙋‍♂️ issue](<https://img.shields.io/badge/☣️-submit_%20_issue-rgb(255,0,63)?logo=github>)](https://github.com/earthnutDev/a-js-tools/issues)
+[![查看 📔 日志](<https://img.shields.io/badge/👀-日_%20_志-rgb(0,125,206)>)](https://github.com/earthnutDev/a-js-tools/blob/main/CHANGELOG.md) [![bug 🙋‍♂️ 提交](<https://img.shields.io/badge/☣️-bug_%20_提交-rgb(255,0,63)>)](https://github.com/earthnutDev/a-js-tools/issues)
 
 ---
 
-A purely functional tool that includes .
+一个纯函数的工具
+
+## 安装
+
+```sh
+npm install   a-js-tools  --save
+```
 
 ## pure function
 
-- `typeOf` Verify data type
-- `lmDebounce` Anti shake function
-- `lmThrottle` Throttling function
-- `getRandomInt` get random int number
-- `getRandomFloat` get random float number
+- `lmDebounce` 防抖函数
+- `lmThrottle` 节流函数
+- `getRandomInt` 获取随机的整数
+- `getRandomFloat` 获取随机的浮点数
 
-## class name
+## class 名称转化
 
 - `toLowerCamelCase` Convert hyphenation to hump
 - `toSplitCase` Convert small hump to hyphen split
 
-## Documentation
+## 查看文档
 
-see [https://earthnut.dev/a-js-tools/](https://earthnut.dev/a-js-tools/)
+产看 [https://earthnut.dev/a-js-tools](https://earthnut.dev/a-js-tools)

package/cjs/src/className.cjs

@@ -0,0 +1,58 @@
+'use strict';
+
+/**
+ * 驼峰命名与连字符命名法的互换
+ *
+ * @packageDocumentation
+ * @module @a-js-tools/class-name
+ * @license MIT
+ */
+/**
+ *
+ * 连字符连接转化为小/大驼峰命名法
+ *
+ * @param str    待转化文本
+ * @param dividingType   连字符，缺省值为 "-"
+ * @param initial 是否转换第一个字符。默认值为 false （小驼峰类型）
+ * @returns 驼峰命名法字符串（e.g. “helloWorld”）
+ *
+ */
+function toLowerCamelCase(
+/**  待转化文本  */
+str, 
+/**  连字符，缺省值为 "-"  */
+dividingType = '-', 
+/** 是否转换第一个字符。默认值为 false （小驼峰类型） */
+initial = false) {
+    let result = str;
+    /**
+     * 匹配规则
+     *
+     * - 匹配到分隔符，将分隔符后面的字符转化为大写
+     */
+    const template = /[\\]|[\^]|[?]|[-]|[.]|[(]|[)]|[|]|[[]\[\]]|[{]|[}]|[+]|[*]|[$]/;
+    /**  转化首字符   */
+    const toTransform = (_str, _dividingType) => _str.replace(new RegExp(`${template.test(_dividingType) ? `\\${_dividingType}` : _dividingType}([a-zA-Z])`, 'g'), (match, p1) => p1.toUpperCase());
+    // 多分隔符转化
+    dividingType.split('').forEach((item) => {
+        result = toTransform(result, item);
+    });
+    return initial
+        ? result.replace(/^./, (match) => match.toUpperCase())
+        : result;
+}
+/**
+ * 驼峰命名法转化为连字符连接
+ *
+ * @param str          待转化文本
+ * @param dividingType       分割符
+ * @returns 分割符转化的文本 (e.g. 'hello-world')
+ *
+ */
+function toSplitCase(str, dividingType = '-') {
+    const result = str.replace(/[A-Z]/g, (match) => dividingType.concat(match.toLowerCase()));
+    return result.startsWith(dividingType) ? result.substring(1) : result;
+}
+
+exports.toLowerCamelCase = toLowerCamelCase;
+exports.toSplitCase = toSplitCase;

package/cjs/src/getRandomNumber.cjs

@@ -0,0 +1,76 @@
+'use strict';
+
+var aTypeOfJs = require('a-type-of-js');
+
+/**
+ * 过去随机数
+ *
+ * @packageDocumentation
+ * @module @a-js-tools/get-random-number
+ * @license MIT
+ */
+/**
+ *
+ * 获取一个随机的整数类型
+ *
+ * 您可以传入两个参数并获取它们之间的任意数字
+ *
+ * 如果只传递一个参数，则如果提供的值为负数，则得到一个小于（或大于）该数字的整数
+ *
+ * @param   max 较大值 ，不允许为`NaN`
+ * @param   min 较小值，不允许为 `NaN`
+ * @returns  任意的整数
+ */
+function getRandomInt(max = 1, min = 0) {
+    //  判断是否为 NaN 或 不是数字
+    if (!isFinite(max) ||
+        !isFinite(min) ||
+        aTypeOfJs.isNaN(max) ||
+        aTypeOfJs.isNaN(min) ||
+        !aTypeOfJs.isNumber(max) ||
+        !aTypeOfJs.isNumber(min)) {
+        throw new TypeError('getRandomInt: max or min is NaN or is not a number');
+    }
+    /**  获取最小值  */
+    let _min = Math.ceil(Number(min)), 
+    /**  获取最大值  */
+    _max = Math.floor(Number(max));
+    /**  两值交换  */
+    if (_min > _max)
+        [_max, _min] = [_min, _max];
+    //**  两值相等时，直接返回最大值  */
+    if (_max === _min)
+        return _max;
+    return Math.round(Math.random() * (_max - _min) + _min);
+}
+/**
+ *
+ * 获取任意的浮点数
+ *
+ * 您可以传入两个参数并获取它们之间的任意数字
+ *
+ * 如果只传入一个参数，则如果提供的值为负数，则获取小于（或大于）该数字的浮点数
+ *
+ * @param   max 较大数，缺省值为 1
+ * @param min 较小值，缺省值为 0
+ * @returns  任意的浮点数
+ */
+function getRandomFloat(max = 1, min = 0) {
+    //  判断是否为 NaN 或 不是数字
+    if (!isFinite(max) ||
+        !isFinite(min) ||
+        aTypeOfJs.isNaN(max) ||
+        aTypeOfJs.isNaN(min) ||
+        !aTypeOfJs.isNumber(max) ||
+        !aTypeOfJs.isNumber(min)) {
+        throw new TypeError('getRandomInt: max or min is NaN or is not a number');
+    }
+    if (max == min)
+        max++;
+    if (min > max)
+        [max, min] = [min, max];
+    return Math.random() * (max - min) + min;
+}
+
+exports.getRandomFloat = getRandomFloat;
+exports.getRandomInt = getRandomInt;

package/{dist/cjs → cjs}/src/performance.cjs

@@ -1,12 +1,19 @@
 'use strict';
 
-/**************************************
+/**
+ * 防抖和节流
+ *
+ * @packageDocumentation
+ * @module @a-js-tools/performance
+ * @license MIT
+ */
+/**
  *
- * 函数防抖
+ * 防抖
  *
- * @param {*} callback
- * @param {number} delay 缺省 300 ms
- * @return {*}   返回的是一个函数
+ * @param   callback 回调函数
+ * @param   delay    延迟时间（毫秒），默认 200 (ms)
+ * @returns   返回的闭包函数
  * @example
  *
  * ```ts
@@ -17,8 +24,7 @@
  *   }
  * }
  *
- **************************************/
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
+ */
 function debounce(callback, delay = 200) {
     if (typeof callback !== 'function') {
         throw new TypeError('callback must be a function');
@@ -51,12 +57,12 @@ function debounce(callback, delay = 200) {
     return result;
 }
 /**
- *  节流函数
- * @param callback
- * @param delay  延迟时间，单位为毫秒（ms），缺省 200（ms）
- * @returns  返回的是一个函数
+ *   节流
+ *
+ * @param callback   回调函数
+ * @param delay      延迟时间（毫秒），默认 200 (ms)
+ * @returns   返回的闭包函数
  */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 function throttle(callback, delay = 200) {
     // 强制转换非数值
     if (!isFinite(delay) || (isFinite(delay) && delay < 0))

package/mjs/src/className.mjs

@@ -0,0 +1,55 @@
+/**
+ * 驼峰命名与连字符命名法的互换
+ *
+ * @packageDocumentation
+ * @module @a-js-tools/class-name
+ * @license MIT
+ */
+/**
+ *
+ * 连字符连接转化为小/大驼峰命名法
+ *
+ * @param str    待转化文本
+ * @param dividingType   连字符，缺省值为 "-"
+ * @param initial 是否转换第一个字符。默认值为 false （小驼峰类型）
+ * @returns 驼峰命名法字符串（e.g. “helloWorld”）
+ *
+ */
+function toLowerCamelCase(
+/**  待转化文本  */
+str, 
+/**  连字符，缺省值为 "-"  */
+dividingType = '-', 
+/** 是否转换第一个字符。默认值为 false （小驼峰类型） */
+initial = false) {
+    let result = str;
+    /**
+     * 匹配规则
+     *
+     * - 匹配到分隔符，将分隔符后面的字符转化为大写
+     */
+    const template = /[\\]|[\^]|[?]|[-]|[.]|[(]|[)]|[|]|[[]\[\]]|[{]|[}]|[+]|[*]|[$]/;
+    /**  转化首字符   */
+    const toTransform = (_str, _dividingType) => _str.replace(new RegExp(`${template.test(_dividingType) ? `\\${_dividingType}` : _dividingType}([a-zA-Z])`, 'g'), (match, p1) => p1.toUpperCase());
+    // 多分隔符转化
+    dividingType.split('').forEach((item) => {
+        result = toTransform(result, item);
+    });
+    return initial
+        ? result.replace(/^./, (match) => match.toUpperCase())
+        : result;
+}
+/**
+ * 驼峰命名法转化为连字符连接
+ *
+ * @param str          待转化文本
+ * @param dividingType       分割符
+ * @returns 分割符转化的文本 (e.g. 'hello-world')
+ *
+ */
+function toSplitCase(str, dividingType = '-') {
+    const result = str.replace(/[A-Z]/g, (match) => dividingType.concat(match.toLowerCase()));
+    return result.startsWith(dividingType) ? result.substring(1) : result;
+}
+
+export { toLowerCamelCase, toSplitCase };

package/mjs/src/getRandomNumber.mjs

@@ -0,0 +1,73 @@
+import { isNaN, isNumber } from 'a-type-of-js';
+
+/**
+ * 过去随机数
+ *
+ * @packageDocumentation
+ * @module @a-js-tools/get-random-number
+ * @license MIT
+ */
+/**
+ *
+ * 获取一个随机的整数类型
+ *
+ * 您可以传入两个参数并获取它们之间的任意数字
+ *
+ * 如果只传递一个参数，则如果提供的值为负数，则得到一个小于（或大于）该数字的整数
+ *
+ * @param   max 较大值 ，不允许为`NaN`
+ * @param   min 较小值，不允许为 `NaN`
+ * @returns  任意的整数
+ */
+function getRandomInt(max = 1, min = 0) {
+    //  判断是否为 NaN 或 不是数字
+    if (!isFinite(max) ||
+        !isFinite(min) ||
+        isNaN(max) ||
+        isNaN(min) ||
+        !isNumber(max) ||
+        !isNumber(min)) {
+        throw new TypeError('getRandomInt: max or min is NaN or is not a number');
+    }
+    /**  获取最小值  */
+    let _min = Math.ceil(Number(min)), 
+    /**  获取最大值  */
+    _max = Math.floor(Number(max));
+    /**  两值交换  */
+    if (_min > _max)
+        [_max, _min] = [_min, _max];
+    //**  两值相等时，直接返回最大值  */
+    if (_max === _min)
+        return _max;
+    return Math.round(Math.random() * (_max - _min) + _min);
+}
+/**
+ *
+ * 获取任意的浮点数
+ *
+ * 您可以传入两个参数并获取它们之间的任意数字
+ *
+ * 如果只传入一个参数，则如果提供的值为负数，则获取小于（或大于）该数字的浮点数
+ *
+ * @param   max 较大数，缺省值为 1
+ * @param min 较小值，缺省值为 0
+ * @returns  任意的浮点数
+ */
+function getRandomFloat(max = 1, min = 0) {
+    //  判断是否为 NaN 或 不是数字
+    if (!isFinite(max) ||
+        !isFinite(min) ||
+        isNaN(max) ||
+        isNaN(min) ||
+        !isNumber(max) ||
+        !isNumber(min)) {
+        throw new TypeError('getRandomInt: max or min is NaN or is not a number');
+    }
+    if (max == min)
+        max++;
+    if (min > max)
+        [max, min] = [min, max];
+    return Math.random() * (max - min) + min;
+}
+
+export { getRandomFloat, getRandomInt };

package/{dist/mjs → mjs}/src/performance.mjs

@@ -1,10 +1,17 @@
-/**************************************
+/**
+ * 防抖和节流
+ *
+ * @packageDocumentation
+ * @module @a-js-tools/performance
+ * @license MIT
+ */
+/**
  *
- * 函数防抖
+ * 防抖
  *
- * @param {*} callback
- * @param {number} delay 缺省 300 ms
- * @return {*}   返回的是一个函数
+ * @param   callback 回调函数
+ * @param   delay    延迟时间（毫秒），默认 200 (ms)
+ * @returns   返回的闭包函数
  * @example
  *
  * ```ts
@@ -15,8 +22,7 @@
  *   }
  * }
  *
- **************************************/
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
+ */
 function debounce(callback, delay = 200) {
     if (typeof callback !== 'function') {
         throw new TypeError('callback must be a function');
@@ -49,12 +55,12 @@ function debounce(callback, delay = 200) {
     return result;
 }
 /**
- *  节流函数
- * @param callback
- * @param delay  延迟时间，单位为毫秒（ms），缺省 200（ms）
- * @returns  返回的是一个函数
+ *   节流
+ *
+ * @param callback   回调函数
+ * @param delay      延迟时间（毫秒），默认 200 (ms)
+ * @returns   返回的闭包函数
  */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 function throttle(callback, delay = 200) {
     // 强制转换非数值
     if (!isFinite(delay) || (isFinite(delay) && delay < 0))

package/package.json

@@ -1,33 +1,22 @@
 {
   "type": "module",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "name": "a-js-tools",
-  "main": "dist/cjs/index.cjs",
-  "module": "dist/mjs/index.mjs",
-  "typings": "dist/types/index.d.ts",
+  "main": "cjs/index.cjs",
+  "module": "mjs/index.mjs",
+  "typings": "types/index.d.ts",
   "description": "Some functions that are available in js",
   "files": [
-    "dist/",
+    "mjs",
+    "cjs",
+    "types",
     "CHANGELOG-en.md",
     "CHANGELOG.md"
   ],
   "exports": {
-    "import": "./dist/mjs/index.mjs",
-    "require": "./dist/cjs/index.cjs",
-    "types": "./dist/types/index.d.ts"
-  },
-  "scripts": {
-    "b": "rollup --config rollup.config.js && tsc -p tsconfig.types.json",
-    "build": "npx ixxx rm dist && npm run b",
-    "push:version": "bash -c 'git add . && git commit  -m \"version: $1 $(date +\"%Y-%m-%d %H:%M:%S\")${2:+ }$2\" && git tag -a \"v$1\" -m \"$(date +\"%Y-%m-%d %H:%M:%S\")${2:+ }$2\" && git push origin main --tags' -- ",
-    "push:submit": "bash -c 'git add . && git commit -m \"submit: $(date +\"%Y-%m-%d %H:%M:%S\")${1:+ }$1\" && git push origin main' -- ",
-    "clean": "npx ixxx up -d r node_modules package-lock.json && npm install && npm run build",
-    "prettier": "npx prettier . --write",
-    "test": "npx ixxx clear && npx jest --coverage",
-    "coverage": "codecov",
-    "report": "cat ./coverage/lcov.info | coveralls",
-    "versionPatch": "npx ixxx up -n",
-    "pub": "npm run build && npm publish --access public"
+    "import": "./mjs/index.mjs",
+    "require": "./cjs/index.cjs",
+    "types": "./types/index.d.ts"
   },
   "repository": {
     "type": "git",
@@ -52,39 +41,6 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "a-type-of-js": ">=0.1.3  <1.0.0"
-  },
-  "devDependencies": {
-    "@babel/core": "^7.26.9",
-    "@babel/preset-env": "^7.26.9",
-    "@babel/preset-typescript": "^7.26.0",
-    "@eslint/js": "^9.6.0",
-    "@rollup/plugin-commonjs": "^25.0.8",
-    "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-node-resolve": "^15.2.3",
-    "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^11.1.6",
-    "@types/expect": "^1.20.4",
-    "@types/jest": "^29.5.14",
-    "@types/node": "^20.14.9",
-    "babel-jest": "^29.7.0",
-    "codecov": "^3.8.2",
-    "coveralls": "^3.1.1",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^9.1.0",
-    "expect": "^29.7.0",
-    "globals": "^15.7.0",
-    "jest": "^29.7.0",
-    "jest-environment-jsdom": "^29.7.0",
-    "jest-junit": "^16.0.0",
-    "prettier": "^3.3.2",
-    "rollup": "^4.35.0",
-    "rollup-plugin-cleanup": "^3.2.1",
-    "rollup-plugin-copy": "^3.5.0",
-    "ts-jest": "^29.2.6",
-    "ts-node": "^10.9.2",
-    "tslib": "^2.6.3",
-    "typescript": "^5.5.3",
-    "typescript-eslint": "^7.15.0"
+    "a-type-of-js": ">=0.1.6 <1.0.0"
   }
 }

package/types/src/className.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 驼峰命名与连字符命名法的互换
+ *
+ * @packageDocumentation
+ * @module @a-js-tools/class-name
+ * @license MIT
+ */
+/**
+ *
+ * 连字符连接转化为小/大驼峰命名法
+ *
+ * @param str    待转化文本
+ * @param dividingType   连字符，缺省值为 "-"
+ * @param initial 是否转换第一个字符。默认值为 false （小驼峰类型）
+ * @returns 驼峰命名法字符串（e.g. “helloWorld”）
+ *
+ */
+export declare function toLowerCamelCase(
+/**  待转化文本  */
+str: string, 
+/**  连字符，缺省值为 "-"  */
+dividingType?: string, 
+/** 是否转换第一个字符。默认值为 false （小驼峰类型） */
+initial?: boolean): string;
+/**
+ * 驼峰命名法转化为连字符连接
+ *
+ * @param str          待转化文本
+ * @param dividingType       分割符
+ * @returns 分割符转化的文本 (e.g. 'hello-world')
+ *
+ */
+export declare function toSplitCase(str: string, dividingType?: string): string;

package/types/src/getRandomNumber.d.ts

@@ -0,0 +1,26 @@
+/**
+ *
+ * 获取一个随机的整数类型
+ *
+ * 您可以传入两个参数并获取它们之间的任意数字
+ *
+ * 如果只传递一个参数，则如果提供的值为负数，则得到一个小于（或大于）该数字的整数
+ *
+ * @param   max 较大值 ，不允许为`NaN`
+ * @param   min 较小值，不允许为 `NaN`
+ * @returns  任意的整数
+ */
+export declare function getRandomInt(max?: number, min?: number): number;
+/**
+ *
+ * 获取任意的浮点数
+ *
+ * 您可以传入两个参数并获取它们之间的任意数字
+ *
+ * 如果只传入一个参数，则如果提供的值为负数，则获取小于（或大于）该数字的浮点数
+ *
+ * @param   max 较大数，缺省值为 1
+ * @param min 较小值，缺省值为 0
+ * @returns  任意的浮点数
+ */
+export declare function getRandomFloat(max?: number, min?: number): number;

package/types/src/getRandomString.d.ts

@@ -0,0 +1,56 @@
+/**
+ *
+ *  Random string generation function
+ *
+ *
+ *
+ */
+export type RandomStringOptions = {
+    /**
+     * 字符串长度
+     *
+     * @default 32
+     */
+    length?: number;
+    /**
+     *  字符集
+     * @default '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
+     */
+    chars?: string;
+    /**
+     *  是否包含数字
+     *
+     * @default false
+     */
+    includeNumbers?: boolean;
+    /**
+     *  是否包含大写字母
+     *
+     * @default false
+     */
+    includeUppercaseLetters?: boolean;
+    /**
+     * 是否包含特殊字符
+     *
+     * @default false
+     */
+    includeSpecial?: boolean;
+    /**
+     * 字符类型
+     *
+     * 缺省值为 'string'，可选为 'uuid'
+     *
+     * @default 'string''
+     */
+    type?: 'string' | 'uuid';
+};
+/**
+ *
+ *  获取随机字符串
+ *
+ *  @param   length - 字符串长度
+ *  @returns  - 随机字符串
+ *
+ *
+ */
+export declare function getRandomString(length?: RandomStringOptions | number): string;

package/types/src/performance.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 防抖和节流
+ *
+ * @packageDocumentation
+ * @module @a-js-tools/performance
+ * @license MIT
+ */
+type Callback = (...args: unknown[]) => void;
+/**
+ *
+ * 节流和防抖返回值类型
+ *
+ */
+export interface DebounceAndThrottleReturnType<F extends Callback> {
+    (...args: Parameters<F>): void;
+    cancel(): void;
+}
+/**
+ *
+ * 防抖
+ *
+ * @param   callback 回调函数
+ * @param   delay    延迟时间（毫秒），默认 200 (ms)
+ * @returns   返回的闭包函数
+ * @example
+ *
+ * ```ts
+ * const debounce = (callback: Function, delay = 300) => {
+ *   let timer: any = null
+ *   return (...args: any[]) => {
+ *     clearTimeout(timer)
+ *   }
+ * }
+ *
+ */
+export declare function debounce<F extends (...args: unknown[]) => void>(callback: F, delay?: number): DebounceAndThrottleReturnType<F>;
+/**
+ *   节流
+ *
+ * @param callback   回调函数
+ * @param delay      延迟时间（毫秒），默认 200 (ms)
+ * @returns   返回的闭包函数
+ */
+export declare function throttle<F extends (...args: unknown[]) => void>(callback: F, delay?: number): DebounceAndThrottleReturnType<F>;
+export {};

package/CHANGELOG-en.md

@@ -1,24 +0,0 @@
-# change log
-
-[![中文 🇨🇳](<https://img.shields.io/badge/🇨🇳-自述_%20_文件-rgb(255,12,36)>)](https://github.com/earthnutDev/a-js-tools/blob/main/README-zh.md) [![English 🌍](<https://img.shields.io/badge/🌍-README-rgb(0,0,0)>)](https://github.com/earthnutDev/a-js-tools/blob/main/README.md) [![查看 📔 日志](<https://img.shields.io/badge/👀-日_%20_志-rgb(0,125,206)>)](https://github.com/earthnutDev/a-js-tools/blob/main/CHANGELOG.md) ![查看 📔 日志](<https://img.shields.io/badge/👀-Change_%20_log-rgb(0,125,206)?style=social>)
-
-## 0.1.0（3/22/2025）
-
-- There are no feature updates
-
-## 0.0.4（3/21/2025）
-
-- There are no feature updates
-- Updated badge links and how test coverage badges are displayed
-
-## 0.0.3（3/16/2025）
-
-- The previous version's dependency `a-type-of-js` exception was not detected and has been fixed
-
-## 0.0.2（3/15/2025）
-
-- add test coverage percentage badge
-
-## 0.0.1（3/7/2025）
-
-- Refine the test

package/CHANGELOG.md

@@ -1,47 +0,0 @@
-# 更新日志
-
-[![中文 🇨🇳](<https://img.shields.io/badge/🇨🇳-自述_%20_文件-rgb(255,12,36)>)](https://github.com/earthnutDev/a-js-tools/blob/main/README-zh.md) [![English 🌍](<https://img.shields.io/badge/🌍-README-rgb(0,0,0)>)](https://github.com/earthnutDev/a-js-tools/blob/main/README.md) ![查看 📔 日志](<https://img.shields.io/badge/👀-日_%20_志-rgb(0,125,206)?style=social>) [![查看 📔 日志](<https://img.shields.io/badge/👀-Change_%20_log-rgb(0,125,206)>)](https://github.com/earthnutDev/a-js-tools/blob/main/CHANGELOG-en.md)
-
-## 0.1.0 (3 月 22 日 2025 年)
-
-- 没有更新功能
-
-## 0.0.4 (3 月 21 日 2025 年)
-
-- 没有更新功能
-- 更新了徽章的链接和测试覆盖率徽章的展示方式
-
-## 0.0.3 (3 月 16 日 2025 年)
-
-- 上一个版本的依赖 `a-type-of-js` 异常而未察觉，已修复
-
-## 0.0.2（3 月 15 日 2025 年）
-
-- 添加测试率的徽章
-
-## 0.0.1（3 月 7 日 2025 年）
-
-- 优化了 `typeOf` 的逻辑及返回值的类型收缩
-- 修改了 `debounce` 函数，在返回的函数的原型上添加 `clear` 方法，以便主动取消未执行的定时器
-- 调优了代码结构
-- 由于实际需要，移除了 `t`、`isTTY` 的支持，并转移到 [a-node-tools](https://github.com/earthnutDev/a-node-tools)
-
-## 0.0.0 （6 月 11 日 2024 年）
-
-- 最爱干的事，就是改名字，哈哈哈哈哈
-
-## 0.0.2-5 （6 月 11 日 2024 年）
-
-- 添加了 `eslint`
-
-## 0.0.1 （6 月 11 日 2024 年）
-
-- 维护了导出
-
-## 0.0.0 （6 月 4 日 2024 年）
-
-- 项目做了迁移
-
-## 0.0.1 （4 月 28 日 2024 年）
-
-- 初始化这个项目

package/dist/cjs/src/className.cjs

@@ -1,58 +0,0 @@
-'use strict';
-
-/****************************************************************************
- * @Author earthnut
- * @Email earthnut.dev@outlook.com
- * @ProjectName a-js-tools
- * @FileName className.ts
- * @CreateDate  周六  09/14/2024
- * @Description css 类名转换
- ****************************************************************************/
-/**************************************
- *
- * 转化为驼峰命名法
- *
- * @param str                   待转化的字符串
- * @param [dividingType='-']    分隔符。缺省为 "-"
- * @param [initial=false]       是否转化首字符。缺省为false（小驼峰式）
- * @returns {string}             转化后的字符串
- *
- **************************************/
-function toLowerCamelCase(
-/**  待转化的字符串  */
-str, 
-/**  分隔符。缺省为 "-"  */
-dividingType = '-', 
-/**  是否转化首字符。缺省为false（小驼峰式）  */
-initial = false) {
-    let result = str;
-    /**************************
-     * 匹配规则
-     *
-     * - 匹配到分隔符，将分隔符后面的字符转化为大写
-     **************************/
-    const template = /[\\]|[\^]|[?]|[-]|[.]|[(]|[)]|[|]|[[]\[\]]|[{]|[}]|[+]|[*]|[$]/;
-    /**  转化首字符   */
-    const toTransform = (_str, _dividingType) => _str.replace(new RegExp(`${template.test(_dividingType) ? `\\${_dividingType}` : _dividingType}([a-zA-Z])`, 'g'), (match, p1) => p1.toUpperCase());
-    // 多分隔符转化
-    dividingType.split('').forEach((item) => {
-        result = toTransform(result, item);
-    });
-    return initial
-        ? result.replace(/^./, (match) => match.toUpperCase())
-        : result;
-}
-/**************************************
- *
- * @param str                      转化的字符串
- * @param [dividingType='-']       转化后单词间的连字符
- *
- *
- **************************************/
-function toSplitCase(str, dividingType = '-') {
-    const result = str.replace(/[A-Z]/g, (match) => dividingType.concat(match.toLowerCase()));
-    return result.startsWith(dividingType) ? result.substring(1) : result;
-}
-
-exports.toLowerCamelCase = toLowerCamelCase;
-exports.toSplitCase = toSplitCase;

package/dist/cjs/src/getRandomNumber.cjs

@@ -1,55 +0,0 @@
-'use strict';
-
-var aTypeOfJs = require('a-type-of-js');
-
-/**
- *
- * 获取一个随机整数
- *
- * 可传入两个参数，获取两参数之间的任意数
- *
- * 若只传入一个参数，这获取小于（若提供的值为负数，则为大于）该数的整数
- *
- * @export
- * @param {number} max 最大值，不可为  `NaN`
- * @param {number} [min] 最小值，不可取值 `NaN`
- * @return {*}  {number}
- */
-function getRandomInt(max = 1, min = 0) {
-    //  判断是否为 NaN 或 不是数字
-    if (aTypeOfJs.isNaN(max) || aTypeOfJs.isNaN(min) || !aTypeOfJs.isNumber(max) || !aTypeOfJs.isNumber(min)) {
-        throw new TypeError('getRandomInt: max or min is NaN or is not a number');
-    }
-    /**  获取最小值  */
-    let _min = Math.ceil(Number(min)), 
-    /**  获取最大值  */
-    _max = Math.floor(Number(max));
-    /**  两值交换  */
-    _min > _max && ([_max, _min] = [_min, _max]);
-    //**  两值相等时，直接返回最大值  */
-    if (_max === _min)
-        return _max;
-    return Math.round(Math.random() * (_max - _min) + _min);
-}
-/**
- *
- * 获取一个随机浮点数数
- *
- * 可传入两个参数，获取两参数之间的任意数
- *
- * 若只传入一个参数，这获取小于（若提供的值为负数，则为大于）该数的浮点数数
- *
- * @export
- * @param {number} max 最大值，缺省 1
- * @param {number} [min] 最小值，缺省 0
- * @return {*}  {number}
- */
-function getRandomFloat(max = 1, min = 0) {
-    if (max == min)
-        max++;
-    min > max && ([max, min] = [min, max]);
-    return Math.random() * (max - min) + min;
-}
-
-exports.getRandomFloat = getRandomFloat;
-exports.getRandomInt = getRandomInt;

package/dist/mjs/src/className.mjs

@@ -1,55 +0,0 @@
-/****************************************************************************
- * @Author earthnut
- * @Email earthnut.dev@outlook.com
- * @ProjectName a-js-tools
- * @FileName className.ts
- * @CreateDate  周六  09/14/2024
- * @Description css 类名转换
- ****************************************************************************/
-/**************************************
- *
- * 转化为驼峰命名法
- *
- * @param str                   待转化的字符串
- * @param [dividingType='-']    分隔符。缺省为 "-"
- * @param [initial=false]       是否转化首字符。缺省为false（小驼峰式）
- * @returns {string}             转化后的字符串
- *
- **************************************/
-function toLowerCamelCase(
-/**  待转化的字符串  */
-str, 
-/**  分隔符。缺省为 "-"  */
-dividingType = '-', 
-/**  是否转化首字符。缺省为false（小驼峰式）  */
-initial = false) {
-    let result = str;
-    /**************************
-     * 匹配规则
-     *
-     * - 匹配到分隔符，将分隔符后面的字符转化为大写
-     **************************/
-    const template = /[\\]|[\^]|[?]|[-]|[.]|[(]|[)]|[|]|[[]\[\]]|[{]|[}]|[+]|[*]|[$]/;
-    /**  转化首字符   */
-    const toTransform = (_str, _dividingType) => _str.replace(new RegExp(`${template.test(_dividingType) ? `\\${_dividingType}` : _dividingType}([a-zA-Z])`, 'g'), (match, p1) => p1.toUpperCase());
-    // 多分隔符转化
-    dividingType.split('').forEach((item) => {
-        result = toTransform(result, item);
-    });
-    return initial
-        ? result.replace(/^./, (match) => match.toUpperCase())
-        : result;
-}
-/**************************************
- *
- * @param str                      转化的字符串
- * @param [dividingType='-']       转化后单词间的连字符
- *
- *
- **************************************/
-function toSplitCase(str, dividingType = '-') {
-    const result = str.replace(/[A-Z]/g, (match) => dividingType.concat(match.toLowerCase()));
-    return result.startsWith(dividingType) ? result.substring(1) : result;
-}
-
-export { toLowerCamelCase, toSplitCase };

package/dist/mjs/src/getRandomNumber.mjs

@@ -1,52 +0,0 @@
-import { isNaN, isNumber } from 'a-type-of-js';
-
-/**
- *
- * 获取一个随机整数
- *
- * 可传入两个参数，获取两参数之间的任意数
- *
- * 若只传入一个参数，这获取小于（若提供的值为负数，则为大于）该数的整数
- *
- * @export
- * @param {number} max 最大值，不可为  `NaN`
- * @param {number} [min] 最小值，不可取值 `NaN`
- * @return {*}  {number}
- */
-function getRandomInt(max = 1, min = 0) {
-    //  判断是否为 NaN 或 不是数字
-    if (isNaN(max) || isNaN(min) || !isNumber(max) || !isNumber(min)) {
-        throw new TypeError('getRandomInt: max or min is NaN or is not a number');
-    }
-    /**  获取最小值  */
-    let _min = Math.ceil(Number(min)), 
-    /**  获取最大值  */
-    _max = Math.floor(Number(max));
-    /**  两值交换  */
-    _min > _max && ([_max, _min] = [_min, _max]);
-    //**  两值相等时，直接返回最大值  */
-    if (_max === _min)
-        return _max;
-    return Math.round(Math.random() * (_max - _min) + _min);
-}
-/**
- *
- * 获取一个随机浮点数数
- *
- * 可传入两个参数，获取两参数之间的任意数
- *
- * 若只传入一个参数，这获取小于（若提供的值为负数，则为大于）该数的浮点数数
- *
- * @export
- * @param {number} max 最大值，缺省 1
- * @param {number} [min] 最小值，缺省 0
- * @return {*}  {number}
- */
-function getRandomFloat(max = 1, min = 0) {
-    if (max == min)
-        max++;
-    min > max && ([max, min] = [min, max]);
-    return Math.random() * (max - min) + min;
-}
-
-export { getRandomFloat, getRandomInt };

package/dist/types/src/className.d.ts

@@ -1,33 +0,0 @@
-/****************************************************************************
- * @Author earthnut
- * @Email earthnut.dev@outlook.com
- * @ProjectName a-js-tools
- * @FileName className.ts
- * @CreateDate  周六  09/14/2024
- * @Description css 类名转换
- ****************************************************************************/
-/**************************************
- *
- * 转化为驼峰命名法
- *
- * @param str                   待转化的字符串
- * @param [dividingType='-']    分隔符。缺省为 "-"
- * @param [initial=false]       是否转化首字符。缺省为false（小驼峰式）
- * @returns {string}             转化后的字符串
- *
- **************************************/
-export declare function toLowerCamelCase(
-/**  待转化的字符串  */
-str: string, 
-/**  分隔符。缺省为 "-"  */
-dividingType?: string, 
-/**  是否转化首字符。缺省为false（小驼峰式）  */
-initial?: boolean): string;
-/**************************************
- *
- * @param str                      转化的字符串
- * @param [dividingType='-']       转化后单词间的连字符
- *
- *
- **************************************/
-export declare function toSplitCase(str: string, dividingType?: string): string;

package/dist/types/src/getRandomNumber.d.ts

@@ -1,28 +0,0 @@
-/**
- *
- * 获取一个随机整数
- *
- * 可传入两个参数，获取两参数之间的任意数
- *
- * 若只传入一个参数，这获取小于（若提供的值为负数，则为大于）该数的整数
- *
- * @export
- * @param {number} max 最大值，不可为  `NaN`
- * @param {number} [min] 最小值，不可取值 `NaN`
- * @return {*}  {number}
- */
-export declare function getRandomInt(max?: number, min?: number): number;
-/**
- *
- * 获取一个随机浮点数数
- *
- * 可传入两个参数，获取两参数之间的任意数
- *
- * 若只传入一个参数，这获取小于（若提供的值为负数，则为大于）该数的浮点数数
- *
- * @export
- * @param {number} max 最大值，缺省 1
- * @param {number} [min] 最小值，缺省 0
- * @return {*}  {number}
- */
-export declare function getRandomFloat(max?: number, min?: number): number;

package/dist/types/src/getRandomString.d.ts

@@ -1,48 +0,0 @@
-/**************************************
- *
- *  随机字符串生成函数
- *
- *
- *
- **************************************/
-export type RandomStringOptions = {
-    /**************************
-     * 字符串长度
-     * @default 32
-     **************************/
-    length?: number;
-    /**************************
-     * 字符串可选字符
-     * @default '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
-     **************************/
-    chars?: string;
-    /**************************
-     * 是否包含数字
-     * @default false
-     **************************/
-    includeNumbers?: boolean;
-    /**************************
-     * 是否包含大写字母
-     * @default false
-     **************************/
-    includeUppercaseLetters?: boolean;
-    /**************************
-     * 是否包含特殊字符
-     * @default false
-     **************************/
-    includeSpecial?: boolean;
-    /**************************
-     * 字符串类型
-     * @default 'string''
-     **************************/
-    type?: 'string' | 'uuid';
-};
-/**************************************
- *
- *  随机字符串生成函数
- *  @param {number} length - 字符串长度
- *  @returns {string} - 生成的随机字符串
- *
- *
- **************************************/
-export declare function getRandomString(length?: RandomStringOptions | number): string;

package/dist/types/src/performance.d.ts

@@ -1,40 +0,0 @@
-type Callback = (...args: unknown[]) => void;
-/**************************
- * DebounceAndThrottleReturnType
- *
- *
- *
- * @description: 函数防抖和函数节流的返回类型
- *
- **************************/
-export interface DebounceAndThrottleReturnType<F extends Callback> {
-    (...args: Parameters<F>): void;
-    cancel(): void;
-}
-/**************************************
- *
- * 函数防抖
- *
- * @param {*} callback
- * @param {number} delay 缺省 300 ms
- * @return {*}   返回的是一个函数
- * @example
- *
- * ```ts
- * const debounce = (callback: Function, delay = 300) => {
- *   let timer: any = null
- *   return (...args: any[]) => {
- *     clearTimeout(timer)
- *   }
- * }
- *
- **************************************/
-export declare function debounce<F extends (...args: any[]) => void>(callback: F, delay?: number): DebounceAndThrottleReturnType<F>;
-/**
- *  节流函数
- * @param callback
- * @param delay  延迟时间，单位为毫秒（ms），缺省 200（ms）
- * @returns  返回的是一个函数
- */
-export declare function throttle<F extends (...args: any[]) => void>(callback: F, delay?: number): DebounceAndThrottleReturnType<F>;
-export {};