a-js-tools 0.0.0

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) <2024> <letmiseesee>
+
+Permission to use, copy, modify, and/or distribute this software for any  
+purpose with or without fee is hereby granted, provided that the above  
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES  
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF  
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR  
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES  
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN  
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF  
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,25 @@
+# a-js-tools
+
+A purely functional tool that includes
+
+- pure function
+
+## language
+
+[English](https://github.com/lmssee/js-tools/blob/main/README.md) [中文](https://github.com/lmssee/js-tools/blob/main/自述文件.md)
+
+## install
+
+```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
+
+If you have any questions, you can directly [submit question](https://github.com/lmssee/js-tools/issues/new)

package/cjs/index.cjs

@@ -0,0 +1,14 @@
+'use strict';
+
+var pureFunction = require('./src/pureFunction.cjs');
+var data = require('./src/data.cjs');
+
+
+
+exports.debounce = pureFunction.debounce;
+exports.getRandomFloat = pureFunction.getRandomFloat;
+exports.getRandomInt = pureFunction.getRandomInt;
+exports.throttle = pureFunction.throttle;
+exports.typeOf = pureFunction.typeOf;
+exports.isTTY = data.isTTY;
+exports.t = data.t;

package/cjs/src/data.cjs

@@ -0,0 +1,9 @@
+'use strict';
+
+/**  ANSI 转义序列  */
+const t = '\x1b[';
+/** 当前是否为终端环境   */
+const isTTY = () => process && process.stdout && process.stdout.isTTY;
+
+exports.isTTY = isTTY;
+exports.t = t;

package/cjs/src/pureFunction.cjs

@@ -0,0 +1,120 @@
+'use strict';
+
+/**
+ * 获取数据的类型
+ *
+ * @param {*} o 任意数据
+ * @return {*}  返回是一个字符串 {@link String}，包含于   @see  {@link TypeOf}
+ */
+function typeOf(o) {
+    return Reflect.apply(Object.prototype.toString, o, [])
+        .replace(/^.*\s(.*)]$/, '$1')
+        .toLowerCase();
+}
+/**
+ * 防抖
+ *
+ *  这种设计有一种不好的地方就是倘若最后一次尚未执行，不好清理
+ * @param {*} callback
+ * @param {number} delay 缺省 300 ms
+ * @return {*}   返回的是一个函数
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function debounce(callback, delay = 200) {
+    // 强制转换非数值
+    if (typeof delay != 'number' || isNaN(delay))
+        delay = 200;
+    let timeout;
+    return ((...args) => {
+        clearTimeout(timeout);
+        timeout = setTimeout(() => Reflect.apply(callback, null, args), Math.max(delay, 0));
+    });
+}
+/**
+ *  节流函数
+ * @param callback
+ * @param delay  延迟时间，单位为毫秒（ms），缺省 200（ms）
+ * @returns  返回的是一个函数
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function throttle(callback, delay = 200) {
+    // 强制转换非数值
+    if (typeof delay != 'number' || isNaN(delay))
+        delay = 200;
+    /**  延迟控制插销   */
+    let inThrottle = true;
+    return ((...args) => {
+        if (!inThrottle)
+            return;
+        Reflect.apply(callback, null, args);
+        inThrottle = false;
+        setTimeout(() => (inThrottle = true), Math.max(delay, 0));
+    });
+}
+/** 响应的  */
+// function responsive(target: any) {
+//   const handle = {
+//     get(target: any, key: any, receiver: any) {
+//       console.log(`捕获到 key: ${key}`);
+//       return Reflect.get(target, key, receiver);
+//     },
+//     set(target: any, key: any, value: any, receiver: any) {
+//       console.log(`设置值 ${value} 到属性 ${key}`);
+//       return Reflect.set(target, key, value, receiver);
+//     },
+//   };
+//   return new Proxy(target, handle);
+// }
+/**
+ * 监听
+ */
+// function Listener(vm: any, expOrFn: any, cb: any) {
+//   // @ts-ignore
+//   (this.vm = vm),
+//     (this.expOrFn = expOrFn),
+//     (this.cb = cb),
+//     Reflect.apply(this.cb, this.vm, [this.evaluate()]);
+// }
+/**
+ *
+ * 获取一个随机整数
+ *
+ * 可传入两个参数，获取两参数之间的任意数
+ *
+ * 若只传入一个参数，这获取小于（若提供的值为负数，则为大于）该数的整数
+ *
+ * @export
+ * @param {number} max 最大值
+ * @param {number} [min] 最小值
+ * @return {*}  {number}
+ */
+function getRandomInt(max = 1, min = 0) {
+    let _min = Math.ceil(Number(min)), _max = Math.floor(Number(max));
+    _min > _max && ([_max, _min] = [_min, _max]);
+    return Math.floor(Math.random() * (_max - _min + 1) + _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.debounce = debounce;
+exports.getRandomFloat = getRandomFloat;
+exports.getRandomInt = getRandomInt;
+exports.throttle = throttle;
+exports.typeOf = typeOf;

package/mjs/index.mjs

@@ -0,0 +1,2 @@
+export { debounce, getRandomFloat, getRandomInt, throttle, typeOf } from './src/pureFunction.mjs';
+export { isTTY, t } from './src/data.mjs';

package/mjs/src/data.mjs

@@ -0,0 +1,6 @@
+/**  ANSI 转义序列  */
+const t = '\x1b[';
+/** 当前是否为终端环境   */
+const isTTY = () => process && process.stdout && process.stdout.isTTY;
+
+export { isTTY, t };

package/mjs/src/pureFunction.mjs

@@ -0,0 +1,114 @@
+/**
+ * 获取数据的类型
+ *
+ * @param {*} o 任意数据
+ * @return {*}  返回是一个字符串 {@link String}，包含于   @see  {@link TypeOf}
+ */
+function typeOf(o) {
+    return Reflect.apply(Object.prototype.toString, o, [])
+        .replace(/^.*\s(.*)]$/, '$1')
+        .toLowerCase();
+}
+/**
+ * 防抖
+ *
+ *  这种设计有一种不好的地方就是倘若最后一次尚未执行，不好清理
+ * @param {*} callback
+ * @param {number} delay 缺省 300 ms
+ * @return {*}   返回的是一个函数
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function debounce(callback, delay = 200) {
+    // 强制转换非数值
+    if (typeof delay != 'number' || isNaN(delay))
+        delay = 200;
+    let timeout;
+    return ((...args) => {
+        clearTimeout(timeout);
+        timeout = setTimeout(() => Reflect.apply(callback, null, args), Math.max(delay, 0));
+    });
+}
+/**
+ *  节流函数
+ * @param callback
+ * @param delay  延迟时间，单位为毫秒（ms），缺省 200（ms）
+ * @returns  返回的是一个函数
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function throttle(callback, delay = 200) {
+    // 强制转换非数值
+    if (typeof delay != 'number' || isNaN(delay))
+        delay = 200;
+    /**  延迟控制插销   */
+    let inThrottle = true;
+    return ((...args) => {
+        if (!inThrottle)
+            return;
+        Reflect.apply(callback, null, args);
+        inThrottle = false;
+        setTimeout(() => (inThrottle = true), Math.max(delay, 0));
+    });
+}
+/** 响应的  */
+// function responsive(target: any) {
+//   const handle = {
+//     get(target: any, key: any, receiver: any) {
+//       console.log(`捕获到 key: ${key}`);
+//       return Reflect.get(target, key, receiver);
+//     },
+//     set(target: any, key: any, value: any, receiver: any) {
+//       console.log(`设置值 ${value} 到属性 ${key}`);
+//       return Reflect.set(target, key, value, receiver);
+//     },
+//   };
+//   return new Proxy(target, handle);
+// }
+/**
+ * 监听
+ */
+// function Listener(vm: any, expOrFn: any, cb: any) {
+//   // @ts-ignore
+//   (this.vm = vm),
+//     (this.expOrFn = expOrFn),
+//     (this.cb = cb),
+//     Reflect.apply(this.cb, this.vm, [this.evaluate()]);
+// }
+/**
+ *
+ * 获取一个随机整数
+ *
+ * 可传入两个参数，获取两参数之间的任意数
+ *
+ * 若只传入一个参数，这获取小于（若提供的值为负数，则为大于）该数的整数
+ *
+ * @export
+ * @param {number} max 最大值
+ * @param {number} [min] 最小值
+ * @return {*}  {number}
+ */
+function getRandomInt(max = 1, min = 0) {
+    let _min = Math.ceil(Number(min)), _max = Math.floor(Number(max));
+    _min > _max && ([_max, _min] = [_min, _max]);
+    return Math.floor(Math.random() * (_max - _min + 1) + _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 { debounce, getRandomFloat, getRandomInt, throttle, typeOf };

package/package.json

@@ -0,0 +1,68 @@
+{
+  "type": "module",
+  "version": "0.0.0",
+  "name": "a-js-tools",
+  "main": "cjs/index.cjs",
+  "module": "mjs/index.mjs",
+  "typings": "types/index.d.ts",
+  "description": "some  function",
+  "files": [
+    "cjs/",
+    "mjs/",
+    "types/"
+  ],
+  "exports": {
+    "import": "./mjs/index.mjs",
+    "require": "./cjs/index.cjs",
+    "types": "./types/index.d.ts"
+  },
+  "scripts": {
+    "b": "rollup --config rollup.config.js && tsc -p tsconfig.types.json",
+    "build": "npx ixxx rm dist run b",
+    "clean": "npx ixxx up -d r node_modules package-lock.json run npm install run build",
+    "prettier": "npx prettier . --write",
+    "test": "npx ixxx rm  test/out  && rollup --config rollup.config.test.js && node test/out/test/index.mjs",
+    "versionPatch": "npm version patch --force  --no-git-tag-version  --allow-same-version=true",
+    "up": "npx ixxx pkg -u && npm run versionPatch && npm run build &&  cd dist && npm publish  && cd ../"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lmssee/js-tools.git"
+  },
+  "keywords": [
+    "js-tools",
+    "a-js-tools"
+  ],
+  "author": "lmssee <lmssee@outlook.com>  (https://lmssee.github.io)",
+  "homepage": "https://lmssee.github.io/js-tools",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/lmssee/js-tools/issues",
+    "email": "lmssee@outlook.com"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "tslib": "^2.6.3"
+  },
+  "devDependencies": {
+    "@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/node": "^20.14.9",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "globals": "^15.7.0",
+    "prettier": "^3.3.2",
+    "rollup-plugin-cleanup": "^3.2.1",
+    "rollup-plugin-copy": "^3.5.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.5.3",
+    "typescript-eslint": "^7.15.0"
+  }
+}

package/types/index.d.ts

@@ -0,0 +1,2 @@
+export { throttle, debounce, TypeOf, typeOf, getRandomInt, getRandomFloat, } from './src/pureFunction';
+export { t, isTTY } from './src/data';

package/types/src/data.d.ts

@@ -0,0 +1,4 @@
+/**  ANSI 转义序列  */
+export declare const t = "\u001B[";
+/** 当前是否为终端环境   */
+export declare const isTTY: () => boolean;

package/types/src/pureFunction.d.ts

@@ -0,0 +1,95 @@
+/** 数据类型
+ *
+ * {@link typeOf} 检测出来的数据类型
+ *
+ *  - number 数组类型 {@link Number}
+ *  - function 函数（一种特殊的对象） {@link Function}
+ *  - string  字符串 {@link String}
+ *  - array 数组（一种有序的对象） {@link Array}
+ *  - boolean  布尔值 {@link Boolean} ，仅有  true 和 false 两种能值
+ *  - undefined 值未定义或未赋值 {@link undefined}
+ *  - object 对象 {@link Object}、{@link Proxy}
+ *  - null  指向一个特殊的空对象  null
+ *  - regexp 正则 {@link RegExp}
+ *  - set 值的集合 {@link Set}
+ *  - map 保存键值对，且有序的  {@link Map}
+ *  -  date  时间  {@link Date}
+ *  - bigint 内置对象，它提供了一种方法来表示大于 2^53 - 1 的整数 {@link BigInt}
+ *  - bigint64array  64 位有符号整数组成的数组 {@link BigInt64Array}
+ *  - biguint64array  64 位无符号整数组成的数组 {@link BigInt64Array}
+ *  - symbol
+ *  - error 错误类型 {@link Error}、 {@link URIError}、{@link TypeError}、{@link SyntaxError}、${@link ReferenceError}、{@link RangeError}、{@link EvalError}、{@link AggregateError}
+ * - int8array 二进制补码 8 位有符号整数的数组  {@link Int8Array }
+ *  - uint8array 8 位无符号整型数组  {@link Uint8Array}
+ *  - int16array 二进制补码 16 位有符号整数的数组   {@link Int16Array}
+ *  - uint16array 16 位无符号整数 {@link Uint16Array}
+ *  - int32array二进制补码 32 位有符号整数的数组   {@link Int32Array}
+ *  - uint32array 32 位无符号整型数组  {@link Uint32Array}
+ *  - float32array  32 位的浮点数型数组   {@link Float32Array}
+ *  - float64array  64 位的浮点数型数组   {@link Float64Array}
+ *  - uint8clampedarray  8 位无符号整型固定数组 {@link Uint8ClampedArray}
+ *  - sharedarraybuffer 可以用来在共享内存上创建视图的二进制数据缓冲区，目前，浏览器不支持 {@link SharedArrayBuffer}
+ *  - promise 异步操作最终的完成（或失败）以及其结果值 {@link Promise}
+ *  - window  全局对象 {@link Window}、{@link globalThis}
+ *  - dataview 从二进制 ArrayBuffer 对象中读写多种数值类型的底层接口  {@link DataView}
+ * - atomics 命名空间对象包含对 SharedArrayBuffer 和 ArrayBuffer 对象执行原子操作的静态方法 {@link Atomics}
+ *  - arraybuffer 通用的原始二进制数据缓冲区  {@link ArrayBuffer}
+ *
+ *  _NaN 即便意思非数字的值，但依旧是 {@link Number} 类型_
+ */
+export type TypeOf = 'number' | 'function' | 'string' | 'boolean' | 'object' | 'undefined' | 'null' | 'array' | 'date' | 'set' | 'map' | 'symbol' | 'bigint' | 'bigint64array' | 'biguint64array' | 'regexp' | 'int8array' | 'uint8array' | 'uint16array' | 'float32array' | 'float64array' | 'uint32array' | 'error' | 'uint8clampedarray' | 'sharedarraybuffer' | 'promise' | 'window' | 'dataview' | 'atomics' | 'arraybuffer';
+/**
+ * 获取数据的类型
+ *
+ * @param {*} o 任意数据
+ * @return {*}  返回是一个字符串 {@link String}，包含于   @see  {@link TypeOf}
+ */
+export declare function typeOf(o: unknown): TypeOf;
+/**
+ * 防抖
+ *
+ *  这种设计有一种不好的地方就是倘若最后一次尚未执行，不好清理
+ * @param {*} callback
+ * @param {number} delay 缺省 300 ms
+ * @return {*}   返回的是一个函数
+ */
+export declare function debounce<T extends (...args: any[]) => void>(callback: T, delay?: number): T;
+/**
+ *  节流函数
+ * @param callback
+ * @param delay  延迟时间，单位为毫秒（ms），缺省 200（ms）
+ * @returns  返回的是一个函数
+ */
+export declare function throttle<T extends (...args: any[]) => void>(callback: T, delay?: number): T;
+/** 响应的  */
+/**
+ * 监听
+ */
+/**
+ *
+ * 获取一个随机整数
+ *
+ * 可传入两个参数，获取两参数之间的任意数
+ *
+ * 若只传入一个参数，这获取小于（若提供的值为负数，则为大于）该数的整数
+ *
+ * @export
+ * @param {number} max 最大值
+ * @param {number} [min] 最小值
+ * @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;