@ivujs/i-utils 2.0.0 → 2.1.1

package/dist/es/constants/id-card.d.ts

@@ -1,43 +1,45 @@
-export namespace ID_CARD {
-    let PROVINCE: {
-        11: string;
-        12: string;
-        13: string;
-        14: string;
-        15: string;
-        21: string;
-        22: string;
-        23: string;
-        31: string;
-        32: string;
-        33: string;
-        34: string;
-        35: string;
-        36: string;
-        37: string;
-        41: string;
-        42: string;
-        43: string;
-        44: string;
-        45: string;
-        46: string;
-        50: string;
-        51: string;
-        52: string;
-        53: string;
-        54: string;
-        61: string;
-        62: string;
-        63: string;
-        64: string;
-        65: string;
-        71: string;
-        81: string;
-        82: string;
-        91: string;
-    };
-    namespace SEX {
-        let MAN: string;
-        let WOMAN: string;
-    }
-}
+/**
+ * 身份证号相关常量配置（全局只读）
+ *
+ * PROVINCE: 身份证号前两位对应的省份/地区编码映射
+ *  - 11: 北京
+ *  - 12: 天津
+ *  - 13: 河北
+ *  - 14: 山西
+ *  - 15: 内蒙古
+ *  - 21: 辽宁
+ *  - 22: 吉林
+ *  - 23: 黑龙江
+ *  - 31: 上海
+ *  - 32: 江苏
+ *  - 33: 浙江
+ *  - 34: 安徽
+ *  - 35: 福建
+ *  - 36: 江西
+ *  - 37: 山东
+ *  - 41: 河南
+ *  - 42: 湖北
+ *  - 43: 湖南
+ *  - 44: 广东
+ *  - 45: 广西
+ *  - 46: 海南
+ *  - 50: 重庆
+ *  - 51: 四川
+ *  - 52: 贵州
+ *  - 53: 云南
+ *  - 54: 西藏
+ *  - 61: 陕西
+ *  - 62: 甘肃
+ *  - 63: 青海
+ *  - 64: 宁夏
+ *  - 65: 新疆
+ *  - 71: 台湾
+ *  - 81: 香港
+ *  - 82: 澳门
+ *  - 91: 国外
+ *
+ * SEX: 身份证号解析的性别映射
+ *  - MAN: 男
+ *  - WOMAN: 女
+ */
+export declare const ID_CARD: Record<string, any>;

package/dist/es/constants/id-card.mjs

@@ -1,5 +1,46 @@
 /**
- * 身份证号
+ * 身份证号相关常量配置（全局只读）
+ *
+ * PROVINCE: 身份证号前两位对应的省份/地区编码映射
+ *  - 11: 北京
+ *  - 12: 天津
+ *  - 13: 河北
+ *  - 14: 山西
+ *  - 15: 内蒙古
+ *  - 21: 辽宁
+ *  - 22: 吉林
+ *  - 23: 黑龙江
+ *  - 31: 上海
+ *  - 32: 江苏
+ *  - 33: 浙江
+ *  - 34: 安徽
+ *  - 35: 福建
+ *  - 36: 江西
+ *  - 37: 山东
+ *  - 41: 河南
+ *  - 42: 湖北
+ *  - 43: 湖南
+ *  - 44: 广东
+ *  - 45: 广西
+ *  - 46: 海南
+ *  - 50: 重庆
+ *  - 51: 四川
+ *  - 52: 贵州
+ *  - 53: 云南
+ *  - 54: 西藏
+ *  - 61: 陕西
+ *  - 62: 甘肃
+ *  - 63: 青海
+ *  - 64: 宁夏
+ *  - 65: 新疆
+ *  - 71: 台湾
+ *  - 81: 香港
+ *  - 82: 澳门
+ *  - 91: 国外
+ *
+ * SEX: 身份证号解析的性别映射
+ *  - MAN: 男
+ *  - WOMAN: 女
  */
 const ID_CARD = {
     // 身份证号对应的省

package/dist/es/constants/index.d.ts

@@ -1,7 +1,11 @@
-export * from "./sort.js";
-export * from "./math.js";
-export * from "./lang.js";
-export * from "./regexp.js";
-export * from "./date.js";
-export * from "./keycode.js";
-export * from "./id-card.js";
+/**
+ * 常量
+ * @module 常量集合
+ */
+export * from "./sort";
+export * from "./math";
+export * from "./lang";
+export * from "./regexp";
+export * from "./date";
+export * from "./keycode";
+export * from "./id-card";

package/dist/es/constants/keycode.d.ts

@@ -1,103 +1,119 @@
-export const KEYCODE: {
-    8: string;
-    9: string;
-    13: string;
-    16: string;
-    17: string;
-    18: string;
-    19: string;
-    20: string;
-    27: string;
-    32: string;
-    33: string;
-    34: string;
-    35: string;
-    36: string;
-    37: string;
-    38: string;
-    39: string;
-    40: string;
-    42: string;
-    45: string;
-    46: string;
-    48: string;
-    49: string;
-    50: string;
-    51: string;
-    52: string;
-    53: string;
-    54: string;
-    55: string;
-    56: string;
-    57: string;
-    65: string;
-    66: string;
-    67: string;
-    68: string;
-    69: string;
-    70: string;
-    71: string;
-    72: string;
-    73: string;
-    74: string;
-    75: string;
-    76: string;
-    77: string;
-    78: string;
-    79: string;
-    80: string;
-    81: string;
-    82: string;
-    83: string;
-    84: string;
-    85: string;
-    86: string;
-    87: string;
-    88: string;
-    89: string;
-    90: string;
-    91: string;
-    93: string;
-    96: string;
-    97: string;
-    98: string;
-    99: string;
-    100: string;
-    101: string;
-    102: string;
-    103: string;
-    104: string;
-    105: string;
-    106: string;
-    107: string;
-    109: string;
-    110: string;
-    111: string;
-    112: string;
-    113: string;
-    114: string;
-    115: string;
-    116: string;
-    117: string;
-    118: string;
-    119: string;
-    120: string;
-    121: string;
-    122: string;
-    123: string;
-    144: string;
-    145: string;
-    182: string;
-    183: string;
-    186: string;
-    187: string;
-    188: string;
-    189: string;
-    190: string;
-    191: string;
-    192: string;
-    219: string;
-    220: string;
-    221: string;
-    222: string;
-};
+/**
+ * 键盘码相关常量配置（全局只读）
+ *
+ * 字符键：
+ *  - 8: Backspace
+ *  - 9: Tab
+ *  - 13: Enter
+ *  - 16: Shift
+ *  - 17: Ctrl
+ *  - 18: Alt
+ *  - 19: Pause
+ *  - 20: Caps Lock
+ *  - 27: Escape
+ *  - 32: Space
+ *  - 33: Page Up
+ *  - 34: Page Down
+ *  - 35: End
+ *  - 36: Home
+ *  - 37: Left
+ *  - 38: Up
+ *  - 39: Right
+ *  - 40: Down
+ *  - 42: Print Screen
+ *  - 45: Insert
+ *  - 46: Delete
+ *
+ * 数字键：
+ *  - 48: 0
+ *  - 49: 1
+ *  - 50: 2
+ *  - 51: 3
+ *  - 52: 4
+ *  - 53: 5
+ *  - 54: 6
+ *  - 55: 7
+ *  - 56: 8
+ *  - 57: 9
+ *
+ * 字母键：
+ *  - 65: A
+ *  - 66: B
+ *  - 67: C
+ *  - 68: D
+ *  - 69: E
+ *  - 70: F
+ *  - 71: G
+ *  - 72: H
+ *  - 73: I
+ *  - 74: J
+ *  - 75: K
+ *  - 76: L
+ *  - 77: M
+ *  - 78: N
+ *  - 79: O
+ *  - 80: P
+ *  - 81: Q
+ *  - 82: R
+ *  - 83: S
+ *  - 84: T
+ *  - 85: U
+ *  - 86: V
+ *  - 87: W
+ *  - 88: X
+ *  - 89: Y
+ *  - 90: Z
+ *
+ * window 相关键：
+ *  - 91: Windows
+ *  - 93: Right Click
+ *
+ * 数字小键盘（Numpad）：
+ *  - 96: Numpad 0
+ *  - 97: Numpad 1
+ *  - 98: Numpad 2
+ *  - 99: Numpad 3
+ *  - 100: Numpad 4
+ *  - 101: Numpad 5
+ *  - 102: Numpad 6
+ *  - 103: Numpad 7
+ *  - 104: Numpad 8
+ *  - 105: Numpad 9
+ *  - 106: Numpad *
+ *  - 107: Numpad +
+ *  - 109: Numpad -
+ *  - 110: Numpad .
+ *  - 111: Numpad /
+ *
+ * F功能键：
+ *  - 112: F1
+ *  - 113: F2
+ *  - 114: F3
+ *  - 115: F4
+ *  - 116: F5
+ *  - 117: F6
+ *  - 118: F7
+ *  - 119: F8
+ *  - 120: F9
+ *  - 121: F10
+ *  - 122: F11
+ *  - 123: F12
+ *
+ * 特殊符号/功能键：
+ *  - 144: Num Lock
+ *  - 145: Scroll Lock
+ *  - 182: My Computer
+ *  - 183: My Calculator
+ *  - 186: ;
+ *  - 187: =
+ *  - 188: ,
+ *  - 189: -
+ *  - 190: .
+ *  - 191: /
+ *  - 192: `
+ *  - 219: [
+ *  - 220: \
+ *  - 221: ]
+ *  - 222: '
+ */
+export declare const KEYCODE: Record<string, string>;

package/dist/es/constants/keycode.mjs

@@ -1,5 +1,120 @@
-/*
- * 键盘码
+/**
+ * 键盘码相关常量配置（全局只读）
+ *
+ * 字符键：
+ *  - 8: Backspace
+ *  - 9: Tab
+ *  - 13: Enter
+ *  - 16: Shift
+ *  - 17: Ctrl
+ *  - 18: Alt
+ *  - 19: Pause
+ *  - 20: Caps Lock
+ *  - 27: Escape
+ *  - 32: Space
+ *  - 33: Page Up
+ *  - 34: Page Down
+ *  - 35: End
+ *  - 36: Home
+ *  - 37: Left
+ *  - 38: Up
+ *  - 39: Right
+ *  - 40: Down
+ *  - 42: Print Screen
+ *  - 45: Insert
+ *  - 46: Delete
+ *
+ * 数字键：
+ *  - 48: 0
+ *  - 49: 1
+ *  - 50: 2
+ *  - 51: 3
+ *  - 52: 4
+ *  - 53: 5
+ *  - 54: 6
+ *  - 55: 7
+ *  - 56: 8
+ *  - 57: 9
+ *
+ * 字母键：
+ *  - 65: A
+ *  - 66: B
+ *  - 67: C
+ *  - 68: D
+ *  - 69: E
+ *  - 70: F
+ *  - 71: G
+ *  - 72: H
+ *  - 73: I
+ *  - 74: J
+ *  - 75: K
+ *  - 76: L
+ *  - 77: M
+ *  - 78: N
+ *  - 79: O
+ *  - 80: P
+ *  - 81: Q
+ *  - 82: R
+ *  - 83: S
+ *  - 84: T
+ *  - 85: U
+ *  - 86: V
+ *  - 87: W
+ *  - 88: X
+ *  - 89: Y
+ *  - 90: Z
+ *
+ * window 相关键：
+ *  - 91: Windows
+ *  - 93: Right Click
+ *
+ * 数字小键盘（Numpad）：
+ *  - 96: Numpad 0
+ *  - 97: Numpad 1
+ *  - 98: Numpad 2
+ *  - 99: Numpad 3
+ *  - 100: Numpad 4
+ *  - 101: Numpad 5
+ *  - 102: Numpad 6
+ *  - 103: Numpad 7
+ *  - 104: Numpad 8
+ *  - 105: Numpad 9
+ *  - 106: Numpad *
+ *  - 107: Numpad +
+ *  - 109: Numpad -
+ *  - 110: Numpad .
+ *  - 111: Numpad /
+ *
+ * F功能键：
+ *  - 112: F1
+ *  - 113: F2
+ *  - 114: F3
+ *  - 115: F4
+ *  - 116: F5
+ *  - 117: F6
+ *  - 118: F7
+ *  - 119: F8
+ *  - 120: F9
+ *  - 121: F10
+ *  - 122: F11
+ *  - 123: F12
+ *
+ * 特殊符号/功能键：
+ *  - 144: Num Lock
+ *  - 145: Scroll Lock
+ *  - 182: My Computer
+ *  - 183: My Calculator
+ *  - 186: ;
+ *  - 187: =
+ *  - 188: ,
+ *  - 189: -
+ *  - 190: .
+ *  - 191: /
+ *  - 192: `
+ *  - 219: [
+ *  - 220: \
+ *  - 221: ]
+ *  - 222: '
  */
 const KEYCODE = {
     // 字符键

package/dist/es/constants/lang.d.ts

@@ -1,4 +1,10 @@
-export namespace LANG {
-    let ZH: string;
-    let EN: string;
-}
+/**
+ * 语言相关常量配置（全局只读）
+ *
+ * ZH: 中文
+ *  - zh
+ *
+ * EN: 英文
+ *  - en
+ */
+export declare const LANG: Record<string, any>;

package/dist/es/constants/lang.mjs

@@ -1,5 +1,11 @@
 /**
- * 语言
+ * 语言相关常量配置（全局只读）
+ *
+ * ZH: 中文
+ *  - zh
+ *
+ * EN: 英文
+ *  - en
  */
 const LANG = {
     // 中文

package/dist/es/constants/math.d.ts

@@ -1,4 +1,12 @@
-export namespace MATH {
-    let ROUND: number;
-    let ROUND_FLOOR: number;
-}
+/**
+ * 数学计算相关常量配置（全局只读）
+ *
+ * ROUND: 正常四舍五入
+ *  - 取值：0
+ *  - 示例：1.354保留两位是1.35；1.355保留两位是1.36
+ *
+ * ROUND_FLOOR: 向下舍出
+ *  - 取值：1
+ *  - 示例：1.354保留两位是1.35；1.355保留两位是1.35
+ */
+export declare const MATH: Record<string, any>;

package/dist/es/constants/math.mjs

@@ -1,5 +1,13 @@
 /**
- * 数学
+ * 数学计算相关常量配置（全局只读）
+ *
+ * ROUND: 正常四舍五入
+ *  - 取值：0
+ *  - 示例：1.354保留两位是1.35；1.355保留两位是1.36
+ *
+ * ROUND_FLOOR: 向下舍出
+ *  - 取值：1
+ *  - 示例：1.354保留两位是1.35；1.355保留两位是1.35
  */
 const MATH = {
     // 正常四舍五入，如：1.354保留两位是1.35；1.355保留两位是1.36；

package/dist/es/constants/regexp.d.ts

@@ -1,24 +1,27 @@
-export namespace REGEXP {
-    let CH: RegExp;
-    let EN: RegExp;
-    let LOWER_CASE: RegExp;
-    let UPPER_CASE: RegExp;
-    let CH_NAME: RegExp;
-    let EN_NAME: RegExp;
-    let NUMBER: RegExp;
-    let INTEGER: RegExp;
-    let DECIMAL: RegExp;
-    let INT_OR_FLOAT: RegExp;
-    let MOBILE: RegExp;
-    let PHONE: RegExp;
-    let EMAIL: RegExp;
-    let ID_CARD: RegExp;
-    let ID_CARD15: RegExp;
-    let ID_CARD18: RegExp;
-    let BANK_CARD: RegExp;
-    let POST_CODE: RegExp;
-    let URL: RegExp;
-    let IP: RegExp;
-    let IP6: RegExp;
-    let EXTERNAL: RegExp;
-}
+/**
+ * 正则表达式相关常量配置（全局只读）
+ *
+ * CH: 中文汉字
+ * EN: 英文字母
+ * LOWER_CASE: 小写字母
+ * UPPER_CASE: 大写字母
+ * CH_NAME: 中文姓名（2-16位）
+ * EN_NAME: 英文姓名（1-20位）
+ * NUMBER: 数字（包含正数和负数）
+ * INTEGER: 整数（包含：0，正整数和负整数）
+ * DECIMAL: 小数（包含正小数和负小数）
+ * INT_OR_FLOAT: 正整数或者保留两位小数
+ * MOBILE: 手机号码（支持+86）
+ * PHONE: 固定电话号码（比如：0755-1111111）
+ * EMAIL: 邮箱
+ * ID_CARD: 一代15位或二代18位身份证
+ * ID_CARD15: 仅校验一代15位身份证
+ * ID_CARD18: 仅校验二代18位身份证
+ * BANK_CARD: 银行卡号
+ * POST_CODE: 邮政编码
+ * URL: url地址（可获取主机地址、主机名、端口号、协议、查询参数、hash等信息）
+ * IP: ip地址
+ * IP6: IPv6地址
+ * EXTERNAL: 外链（http、https、mail、tel电话）
+ */
+export declare const REGEXP: Record<string, RegExp>;