@base-web-kits/base-tools-ts 0.8.15 → 0.8.18

package/dist/validator/index.d.ts

@@ -1,296 +0,0 @@
-/**
- * 纯字母（不含空格与符号）。
- * @param s 字符串
- * @returns 是否为字母
- * @example
- * isLetter('abc') // true
- * isLetter('123') // false
- * isLetter('abc123') // false
- */
-export declare function isLetter(s: string): boolean;
-/**
- * 纯中文（不含空格与符号）。
- * @param s 字符串
- * @returns 是否为纯中文
- * @example
- * isChinese('你好') // true
- */
-export declare function isChinese(s: string): boolean;
-/**
- * 纯数字（非负整数,不含空格与符号）。
- * @param s 字符串
- * @returns 是否为数字
- * @example
- * isDigits('12') // true
- * isDigits('1.2') // false
- * isDigits('-12') // false
- * isDigits('a12') // false
- */
-export declare function isDigits(s: string): boolean;
-/**
- * 数字字符串格式校验
- * @param value   待验证值（字符串或数字）
- * @param options 可选项
- * @param options.negative 是否允许负数，默认 false
- * @param options.decimal 小数位数，默认 2（0 表示必须整数）
- * @param options.thousands 是否允许千分位逗号，默认 false
- * @param options.leadZero 是否允许整数部分出现多余前导0 (默认false, 即禁止'007'，但允许'0.50')
- * @example
- * isNumeric('123.45'); // true
- * isNumeric('123.45', { decimal: 0 }); // false
- * isNumeric('-1,234.5', { negative: true, thousands: true }); // true
- * isNumeric('0123', { leadZero: true }); // true（现在允许）
- * isNumeric('0123'); // false（默认禁止）
- * isNumeric('0.50'); // true（始终允许）
- * isNumeric('.5'); // false（整数部分不能省）
- * isNumeric('123.'); // false（小数部分不能省）
- */
-export declare function isNumeric(value: string | number, options?: {
-    negative?: boolean;
-    decimal?: number;
-    thousands?: boolean;
-    leadZero?: boolean;
-}): boolean;
-/**
- * 是否为中国大陆手机号（11 位，以 1 开头，第二位 3-9）。
- * @param s 待校验的号码
- * @returns 是否为合法手机号
- * @example
- * isMobilePhone('13800138000') // true
- * isMobilePhone('12800138000') // false
- */
-export declare function isMobilePhone(s: string): boolean;
-/**
- * 是否为中国大陆座机号（区号-号码，可选分机）。
- * 格式：`0AA-BBBBBBBB(-EXT)`，其中区号 2-3 位、号码 7-8 位、分机 1-6 位。
- * @param s 待校验的号码
- * @returns 是否为合法座机号
- * @example
- * isLandline('010-88888888') // true
- * isLandline('0371-12345678-123') // true
- */
-export declare function isLandline(s: string): boolean;
-/**
- * 联系电话：是否为中国大陆“手机号或座机号”。
- * @param s 待校验的号码
- * @returns 是否为合法的手机号或座机号
- * @example
- * isPhone('13800138000') // true
- * isPhone('010-88888888') // true
- */
-export declare function isPhone(s: string): boolean;
-/**
- * 校验邮箱地址（基于 RFC 5322 的常用子集）。
- * @param s 待校验的邮箱字符串
- * @returns 是否为合法邮箱
- * @example
- * isEmail('user@example.com') // true
- * isEmail('invalid@') // false
- */
-export declare function isEmail(s: string): boolean;
-/**
- * 中文姓名（允许中间点 `·`），长度 2-20。
- * @param s 姓名
- * @returns 是否为合法中文姓名
- * @example
- * isChineseName('张三') // true
- * isChineseName('阿·娜') // true
- */
-export declare function isChineseName(s: string): boolean;
-/**
- * 身份证校验（支持中国大陆严格校验；台湾/香港/澳门做格式校验）。
- * 规则：
- * - 中国大陆（严格）：18 位校验位 + 出生日期合法性；兼容 15 位旧号（日期校验）；
- * - 台湾（格式）：`^[A-Z][12]\d{8}$`（首字母 + 性别位 1/2 + 8 位数字）；不含校验位算法；
- * - 香港（格式）：`^[A-Z]{1,2}\d{6}\(?[0-9A]\)?$`（1-2 字母 + 6 位数字 + 校验位，可带括号）；
- * - 澳门（格式）：常见为 `^[157]\d{6}\(?\d\)?$`（类别位 1/5/7 + 7 位数字 + 校验位，可带括号）。
- * @param code 身份证号码
- * @returns 是否为合法身份证号
- * @example
- * isIdentityCard('11010519491231002X') // true（大陆）
- * isIdentityCard('A123456789') // true（台湾格式）
- * isIdentityCard('A123456(3)') // true（香港格式）
- * isIdentityCard('1234567(8)') // true（澳门格式）
- */
-export declare function isIdentityCard(code: string): boolean;
-/**
- * 护照号码校验（宽松通用格式，适合单输入框无法确认国家的场景）。
- * 说明：各国护照格式差异较大，此函数提供常见模式的格式校验；不做校验位算法。
- * 包含：
- * - 中国护照常见：`E/G` 开头 + 8 位数字；`D/P/S` 开头 + 7 位数字；
- * - 台湾护照常见：首字母 + 8 位数字；
- * - 通用兜底：6-9 位的字母数字组合；移除输入中的空格与 `-` 后再校验。
- * @param s 护照号码
- * @returns 是否匹配常见护照格式
- * @example
- * isPassport('E12345678') // true
- * isPassport('P1234567') // true
- * isPassport('A12345678') // true（台湾常见）
- * isPassport('AB-1234567') // true（移除分隔符后匹配）
- */
-export declare function isPassport(s: string): boolean;
-/**
- * 港澳通行证（回乡证）号码校验。
- * 说明：常见为 `H/M` 开头 + 8~10 位数字；自动移除输入中的空格与 `-`。
- * @param s 证件号
- * @returns 是否为港澳通行证格式
- * @example
- * isHKMOPermit('H12345678') // true
- * isHKMOPermit('M1234567890') // true
- */
-export declare function isHKMOPermit(s: string): boolean;
-/**
- * 台湾居民来往大陆通行证（台胞证）号码校验。
- * 说明：常见为 8 位纯数字；或首字母 + 8 位数字；部分场景存在 10 位数字。
- * @param s 证件号
- * @returns 是否为台胞证格式
- * @example
- * isTaiwanPermit('12345678') // true
- * isTaiwanPermit('T12345678') // true
- * isTaiwanPermit('1234567890') // true
- */
-export declare function isTaiwanPermit(s: string): boolean;
-/**
- * 军官证号码校验：字母数字组合，长度 7-18。
- * @param s 证件号
- * @returns 是否为军官证宽松格式
- * @example
- * isOfficerIdLoose('JX1234567') // true
- */
-export declare function isOfficerId(s: string): boolean;
-/**
- * 士兵证号码校验：字母数字组合，长度 7-18。
- * @param s 证件号
- * @returns 是否为士兵证格式
- * @example
- * isSoldierId('SB12345678') // true
- */
-export declare function isSoldierId(s: string): boolean;
-/**
- * 中国军证（军官证/士兵证）组合校验。
- * @param s 证件号
- * @returns 是否为军官证或士兵证格式
- * @example
- * isCnMilitaryId('JX1234567') // true
- */
-export declare function isMilitaryId(s: string): boolean;
-/**
- * 银行卡号校验（Luhn 校验）。
- * 说明：移除空格与 `-` 后进行 Luhn 校验；长度通常为 12-19 位。
- * @param s 银行卡号
- * @returns 是否通过 Luhn 校验
- * @example
- * isBankCard('6222 0201 2345 6789') // true
- */
-export declare function isBankCard(s: string): boolean;
-/**
- * 中国车牌号校验（含普通与新能源）。
- * @param s 车牌号码
- * @returns 是否为合法中国车牌
- * @example
- * isLicensePlate('京A12345') // true
- * isLicensePlate('沪A12345D') // 新能源（末位 D/F）
- * isLicensePlate('粤BDF12345') // 新能源（第三位 D/F）
- */
-export declare function isLicensePlate(s: string): boolean;
-/**
- * 校验统一社会信用代码（中国税号常用：18 位，含校验位）。
- * 规则：
- * - 字符集：数字与大写字母（不含 I/O/Z/S/V），即 `[0-9A-HJ-NPQRTUWXY]`；
- * - 前 17 位参与加权求和，最后一位为校验码（取值 0-9 或 大写字母）。
- * @param code 税号/统一社会信用代码
- * @returns 是否为合法税号
- * @example
- * isTaxID('91350100M000100Y43') // true/false 取决于校验位
- */
-export declare function isTaxID(code: string): boolean;
-/**
- * 判断字符串是否为合法 JSON 文本。
- * 说明：传入字符串时尝试 `JSON.parse`；传入对象/数组则视为合法。
- * @param input 待判定的值或字符串
- * @returns 是否为合法 JSON
- * @example
- * isJSON('{"a":1}') // true
- * isJSON('[1,2]') // true
- * isJSON('abc') // false
- */
-export declare function isJSON(input: unknown): boolean;
-/**
- * HEX 颜色值（支持 `#RGB`、`#RRGGBB`、`#RRGGBBAA`）。
- * @param s 颜色字符串
- * @returns 是否为合法 HEX 颜色
- * @example
- * isHexColor('#fff') // true
- * isHexColor('#00ff00') // true
- * isHexColor('#11223344') // true
- */
-export declare function isHexColor(s: string): boolean;
-/**
- * 校验 URL（要求含协议，支持 http/https/ftp）。
- * @param s 待校验的地址
- * @returns 是否为合法 URL
- * @example
- * isURL('https://example.com/path?a=1') // true
- * isURL('example.com') // false（缺少协议）
- */
-export declare function isURL(s: string): boolean;
-/**
- * 判断是否为合法 IPv6 地址（支持压缩表示与 IPv4 映射）。
- * 规则：
- * - 由 8 组 1~4 位十六进制数组成，允许一次 `::` 压缩；
- * - 允许最后一组使用 IPv4 映射（如 `::ffff:192.168.0.1`）。
- * @param s IP 字符串
- * @returns 是否为合法 IPv6
- * @example
- * isIPv6('2001:0db8:85a3:0000:0000:8a2e:0370:7334') // true
- * isIPv6('2001:db8::8a2e:370:7334') // true
- * isIPv6('2001:::370:7334') // false
- */
-export declare function isIPv6(s: string): boolean;
-/**
- * 校验 IP（支持 IPv4 与 IPv6）。
- * @param s IP 字符串
- * @param version 指定版本：传 `4` 仅校验 IPv4，传 `6` 仅校验 IPv6；缺省同时校验两者
- * @returns 是否为合法 IP
- * @example
- * isIP('127.0.0.1') // true
- * isIP('::1') // true
- * isIP('127.0.0.1', 6) // false
- */
-export declare function isIP(s: string, version?: 4 | 6 | '4' | '6'): boolean;
-/**
- * 校验 CIDR IP 段（支持 IPv4/IPv6），形如 `IP/前缀长度`。
- * @param s CIDR 字符串，如 `192.168.0.0/24`、`2001:db8::/32`
- * @returns 是否为合法 CIDR
- * @example
- * isIPRange('10.0.0.0/8') // true
- * isIPRange('2001:db8::/129') // false
- */
-export declare function isIPRange(s: string): boolean;
-/**
- * 端口号校验（0 ~ 65535，整数）。
- * @param s 端口（字符串或数字）
- * @returns 是否为合法端口范围
- * @example
- * isPortNumber(80) // true
- * isPortNumber('65535') // true
- * isPortNumber(70000) // false
- */
-export declare function isPortNumber(s: string | number): boolean;
-/**
- * 纬度校验（-90 ~ 90）。
- * @param s 纬度值（字符串或数字）
- * @returns 是否为合法纬度
- * @example
- * isLatitude('31.2304') // true
- */
-export declare function isLatitude(s: string | number): boolean;
-/**
- * 经度校验（-180 ~ 180）。
- * @param s 经度值（字符串或数字）
- * @returns 是否为合法经度
- * @example
- * isLongitude('121.4737') // true
- */
-export declare function isLongitude(s: string | number): boolean;
-//# sourceMappingURL=index.d.ts.map

package/dist/validator/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/ts/validator/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,WAEjC;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,MAAM,WAGlC;AAED;;;;;;;;;GASG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,WAEjC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,SAAS,CACvB,KAAK,EAAE,MAAM,GAAG,MAAM,EACtB,OAAO,CAAC,EAAE;IACR,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,GACA,OAAO,CAkBT;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,WAGtC;AAED;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,WAGnC;AAED;;;;;;;GAOG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,MAAM,WAEhC;AAED;;;;;;;GAOG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,MAAM,WAMhC;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,WAGtC;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,WA8C1C;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,WAUnC;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,WAMrC;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,MAAM,WASvC;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,WAMpC;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,WAMpC;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,WAErC;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,WAiBnC;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,MAAM,WASvC;AAED;;;;;;;;;GASG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,WAcnC;AAED;;;;;;;;;GASG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,WAapC;AAED;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,WAGnC;AAED;;;;;;;GAOG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,MAAM,WAS9B;AAwBD;;;;;;;;;;;GAWG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAmCzC;AAED;;;;;;;;;GASG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,WAI1D;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,MAAM,WAclC;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,WAG9C;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,WAG5C;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,WAG7C"}