@semi-kit/utils 1.1.10 → 1.1.12

package/README.md

@@ -1,23 +1,23 @@
-# tsdown-starter
-
-A starter for creating a TypeScript package.
-
-## Development
-
-- Install dependencies:
-
-```bash
-npm install
-```
-
-- Run the unit tests:
-
-```bash
-npm run test
-```
-
-- Build the library:
-
-```bash
-npm run build
-```
+# tsdown-starter
+
+A starter for creating a TypeScript package.
+
+## Development
+
+- Install dependencies:
+
+```bash
+npm install
+```
+
+- Run the unit tests:
+
+```bash
+npm run test
+```
+
+- Build the library:
+
+```bash
+npm run build
+```

package/lib/color.d.mts

@@ -1,8 +1,30 @@
+/**
+ * 将 Hex 颜色值转换为 RGB 格式
+ * @param hex - 十六进制颜色值,例如 '#ffffff' 或 'ffffff'
+ * @returns RGB 对象,包含 r、g、b 三个属性
+ * @example
+ * hexToRgb('#ff0000') -> { r: 255, g: 0, b: 0 }
+ */
 declare const hexToRgb: (hex: string) => {
   r: number;
   g: number;
   b: number;
 };
+/**
+ * 将 RGB 颜色值转换为 Hex 格式
+ * @param r - 红色值 (0-255)
+ * @param g - 绿色值 (0-255)
+ * @param b - 蓝色值 (0-255)
+ * @returns 十六进制颜色值字符串
+ * @example
+ * rgbToHex(255, 0, 0) -> '#ff0000'
+ */
 declare const rgbToHex: (r: number, g: number, b: number) => string;
+/**
+ * 随机生成一个 Hex 颜色值
+ * @returns 随机的十六进制颜色值字符串
+ * @example
+ * randomHex() -> '#a3c2f0'
+ */
 declare const randomHex: () => string;
 export { hexToRgb, randomHex, rgbToHex };

package/lib/device.d.mts

@@ -1,6 +1,26 @@
+/**
+ * 判断是否是安卓设备
+ * @returns 如果是安卓设备返回 true,否则返回 false
+ */
 declare const isAndroidMobile: () => boolean;
+/**
+ * 判断是否是苹果设备
+ * @returns 如果是苹果设备(iPhone/iPod/iPad/Mac)返回 true,否则返回 false
+ */
 declare const isAppleMobile: () => boolean;
+/**
+ * 判断是否是微信内置浏览器
+ * @returns 如果是微信浏览器返回 true,否则返回 false
+ */
 declare const isWeChatBrowser: () => boolean;
+/**
+ * 判断是否是 QQ 内置浏览器
+ * @returns 如果是 QQ 浏览器返回 true,否则返回 false
+ */
 declare const isQQBrowser: () => boolean;
+/**
+ * 判断是否是移动设备
+ * @returns 如果是移动设备返回 true,否则返回 false
+ */
 declare const isMobile: () => boolean;
 export { isAndroidMobile, isAppleMobile, isMobile, isQQBrowser, isWeChatBrowser };

package/lib/extra.d.mts

@@ -1,3 +1,12 @@
+/**
+ * 从源对象中提取目标对象中存在的属性,省略多余参数
+ * @param sourceData - 源数据对象
+ * @param targetData - 目标数据对象,确定需要保留的属性
+ * @returns 只包含目标对象中存在的属性
+ * @example
+ * useOmitExtraParams({ a: 1, b: 2, c: 3 }, { a: 1 })
+ */
 declare const useOmitExtraParams: (sourceData: object, targetData: object) => Pick<object, never>;
+/** 占位符, 表示未定义 */
 declare const __: undefined;
 export { __, useOmitExtraParams };

package/lib/localstorage.d.mts

@@ -1,5 +1,31 @@
+/**
+ * 存储 localStorage
+ * @param key - 存储键名
+ * @param value - 存储值,会自动转换为 JSON 字符串
+ * @example
+ * setLocalStorage('user', { name: 'John', age: 30 })
+ */
 declare const setLocalStorage: (key: string, value: any) => void;
+/**
+ * 获取 localStorage 数据
+ * @template T - 返回数据类型
+ * @param key - 存储键名
+ * @returns 解析后的数据,不存在则返回 null
+ * @example
+ * const user = getLocalStorage<User>('user')
+ */
 declare const getLocalStorage: <T>(key: string) => T | null;
+/**
+ * 删除 localStorage 指定键
+ * @param key - 键名
+ * @example
+ * removeLocalStorage('user')
+ */
 declare const removeLocalStorage: (key: string) => void;
+/**
+ * 清空 localStorage
+ * @example
+ * clearLocalStorage()
+ */
 declare const clearLocalStorage: () => void;
 export { clearLocalStorage, getLocalStorage, removeLocalStorage, setLocalStorage };

package/lib/number.d.mts

@@ -1,6 +1,45 @@
+/**
+ * 数字千分位分隔
+ * @param val - 需要格式化的数字
+ * @returns 千分位分隔后的字符串
+ * @example
+ * formatNumberWithCommas(1234567) -> '1,234,567'
+ */
 declare const formatNumberWithCommas: (val: number) => string;
+/**
+ * 生成指定范围内的随机整数
+ * @param min - 最小值(包含)
+ * @param max - 最大值(包含)
+ * @returns 指定范围内的随机整数
+ * @example
+ * getRandomNum(1, 10) -> 7
+ */
 declare const getRandomNum: (min: number, max: number) => number;
+/**
+ * 隐藏手机号中间四位
+ * @param phone - 手机号,支持字符串或数字
+ * @returns 脱敏后的手机号
+ * @example
+ * maskedPhoneNumber('13812345678') -> '138****5678'
+ */
 declare const maskedPhoneNumber: (phone: string | number) => string;
+/**
+ * 格式化手机号,添加分隔符
+ * @param phone - 手机号字符串
+ * @param separator - 分隔符,默认为 '-'
+ * @returns 格式化后的手机号
+ * @example
+ * formatPhoneNumber('13812345678') -> '138-1234-5678'
+ * formatPhoneNumber('13812345678', ' ') -> '138 1234 5678'
+ */
 declare const formatPhoneNumber: (phone: string, separator?: string) => string;
+/**
+ * 判断数字是否为偶数
+ * @param val - 需要判断的数字
+ * @returns 如果是偶数返回 true,否则返回 false
+ * @example
+ * isEven(4) -> true
+ * isEven(3) -> false
+ */
 declare const isEven: (val: number) => boolean;
 export { formatNumberWithCommas, formatPhoneNumber, getRandomNum, isEven, maskedPhoneNumber };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@semi-kit/utils",
-  "version": "1.1.10",
+  "version": "1.1.12",
   "description": "General-purpose tool function library",
   "type": "module",
   "license": "MIT",