@whitesev/utils 2.9.4 → 2.9.5

package/dist/types/eslint.config.d.mts

@@ -0,0 +1,2 @@
+declare const _default: import("eslint/config").Config[];
+export default _default;

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

@@ -1,39 +1,40 @@
 export declare class ColorConversion {
     /**
      * 判断是否是16进制颜色
-     * @param str
+     * @param str 十六进制颜色，如`#000000`
      */
     isHex(str: string): boolean;
     /**
      * 16进制颜色转rgba
      *
      * 例如：`#ff0000` 转为 `rgba(123,123,123, 0.4)`
-     * @param hex
-     * @param opacity
+     * @param hex 十六进制颜色，如`#000000`
+     * @param opacity 透明度，0~1
      */
     hexToRgba(hex: string, opacity: number): string;
     /**
      * hex转rgb
-     * @param str
+     * @param hex 十六进制颜色，如`#000000`
      */
-    hexToRgb(str: string): RegExpMatchArray;
+    hexToRgb(hex: string): RegExpMatchArray;
     /**
      * rgb转hex
-     * @param redValue
-     * @param greenValue
-     * @param blueValue
+     * @param redValue 红色值
+     * @param greenValue 绿色值
+     * @param blueValue 蓝色值
+     * @returns hex
      */
     rgbToHex(redValue: string | number, greenValue: string | number, blueValue: string | number): string;
     /**
      * 获取颜色变暗或亮
-     * @param color 颜色
-     * @param level 0~1.0
+     * @param color hex颜色，如`#000000`
+     * @param level 0~1.0 系数越大，颜色越变暗
      */
-    getDarkColor(color: string, level: string): string;
+    getDarkColor(color: string, level: number | string): string;
     /**
      * 获取颜色变亮
-     * @param color 颜色
-     * @param level 0~1.0
+     * @param color hex颜色，如`#000000`
+     * @param level 0~1.0 系数越大，颜色越变亮
      */
-    getLightColor(color: string, level: number): string;
+    getLightColor(color: string, level: number | string): string;
 }

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

@@ -1120,6 +1120,9 @@ declare class Utils {
      * 复制到剪贴板
      * @param data 需要复制到剪贴板的文本
      * @param info （可选）默认：text/plain
+     * @returns
+     * + true 复制成功
+     * + false 复制失败
      * @example
      * Utils.copy({1:2});
      * > {"1":2}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "@whitesev/utils",
-  "version": "2.9.4",
+  "version": "2.9.5",
   "type": "module",
   "description": "一个常用的工具库",
   "main": "dist/index.cjs.js",
@@ -39,24 +39,24 @@
     "worker-timers": "^8.0.25"
   },
   "devDependencies": {
-    "@eslint/js": "^9.37.0",
+    "@eslint/js": "^9.38.0",
     "@rollup/plugin-commonjs": "^28.0.8",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^16.0.3",
     "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^12.1.4",
-    "browserslist": "^4.26.3",
+    "@rollup/plugin-typescript": "^12.2.0",
+    "browserslist": "^4.27.0",
     "caniuse-lite": "^1.0.30001751",
-    "eslint": "^9.37.0",
+    "eslint": "^9.38.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-compat": "^6.0.2",
     "eslint-plugin-prettier": "^5.5.4",
     "globals": "^16.4.0",
-    "rollup": "^4.52.4",
+    "rollup": "^4.52.5",
     "rollup-plugin-clear": "^2.0.7",
     "tslib": "^2.8.1",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.46.1"
+    "typescript-eslint": "^8.46.2"
   },
   "scripts": {
     "lint": "eslint .",

package/src/ColorConversion.ts

@@ -1,7 +1,7 @@
 export class ColorConversion {
   /**
    * 判断是否是16进制颜色
-   * @param str
+   * @param str 十六进制颜色，如`#000000`
    */
   isHex(str: string): boolean {
     if (typeof str !== "string") {
@@ -16,8 +16,8 @@ export class ColorConversion {
    * 16进制颜色转rgba
    *
    * 例如：`#ff0000` 转为 `rgba(123,123,123, 0.4)`
-   * @param hex
-   * @param opacity
+   * @param hex 十六进制颜色，如`#000000`
+   * @param opacity 透明度，0~1
    */
   hexToRgba(hex: string, opacity: number): string {
     if (!this.isHex(hex)) {
@@ -31,16 +31,16 @@ export class ColorConversion {
   }
   /**
    * hex转rgb
-   * @param str
+   * @param hex 十六进制颜色，如`#000000`
    */
-  hexToRgb(str: string) {
-    if (!this.isHex(str)) {
-      throw new TypeError(`输入错误的hex：${str}`);
+  hexToRgb(hex: string) {
+    if (!this.isHex(hex)) {
+      throw new TypeError(`输入错误的hex：${hex}`);
     }
     /* replace替换查找的到的字符串 */
-    str = str.replace("#", "");
+    hex = hex.replace("#", "");
     /* match得到查询数组 */
-    const hxs = str.match(/../g)!;
+    const hxs = hex.match(/../g)!;
     for (let index = 0; index < 3; index++) {
       const value = parseInt(hxs[index], 16);
       Reflect.set(hxs, index, value);
@@ -50,9 +50,10 @@ export class ColorConversion {
   }
   /**
    * rgb转hex
-   * @param redValue
-   * @param greenValue
-   * @param blueValue
+   * @param redValue 红色值
+   * @param greenValue 绿色值
+   * @param blueValue 蓝色值
+   * @returns hex
    */
   rgbToHex(redValue: string | number, greenValue: string | number, blueValue: string | number): string {
     /* 验证输入的rgb值是否合法 */
@@ -69,17 +70,20 @@ export class ColorConversion {
   }
   /**
    * 获取颜色变暗或亮
-   * @param color 颜色
-   * @param level 0~1.0
+   * @param color hex颜色，如`#000000`
+   * @param level 0~1.0 系数越大，颜色越变暗
    */
-  getDarkColor(color: string, level: string): string {
+  getDarkColor(color: string, level: number | string): string {
     if (!this.isHex(color)) {
       throw new TypeError(`输入错误的hex：${color}`);
     }
+    if (typeof level !== "number") {
+      level = Number(level);
+    }
     const rgbc = this.hexToRgb(color);
     for (let index = 0; index < 3; index++) {
       const rgbcItemValue = rgbc[index];
-      const value = Math.floor(Number(rgbcItemValue) * (1 - Number(level)));
+      const value = Math.floor(Number(rgbcItemValue) * (1 - level));
       Reflect.set(rgbc, index, value);
     }
 
@@ -87,13 +91,16 @@ export class ColorConversion {
   }
   /**
    * 获取颜色变亮
-   * @param color 颜色
-   * @param level 0~1.0
+   * @param color hex颜色，如`#000000`
+   * @param level 0~1.0 系数越大，颜色越变亮
    */
-  getLightColor(color: string, level: number): string {
+  getLightColor(color: string, level: number | string): string {
     if (!this.isHex(color)) {
       throw new TypeError(`输入错误的hex：${color}`);
     }
+    if (typeof level !== "number") {
+      level = Number(level);
+    }
     const rgbc = this.hexToRgb(color);
     for (let index = 0; index < 3; index++) {
       const rgbcItemValue = Number(rgbc[index]);

package/src/Utils.ts

@@ -2544,6 +2544,9 @@ class Utils {
    * 复制到剪贴板
    * @param data 需要复制到剪贴板的文本
    * @param info （可选）默认：text/plain
+   * @returns
+   * + true 复制成功
+   * + false 复制失败
    * @example
    * Utils.copy({1:2});
    * > {"1":2}