@odinlin/utils 0.0.2 → 1.0.0

package/dist/index.d.ts

@@ -1,496 +0,0 @@
-/**
- * @title 若condition为true则什么也不做，否则抛出异常
- * @param { boolean } condition 条件
- * @param { string } message 自定义错误信息
- */
-declare const assert: (condition: boolean, message: string) => asserts condition;
-/**
- * @title 通过toString判断数据类型
- * @param { unknown } target 需要判断的数据
- * @param mode -1 小写 0 不变 1 大写
- * @returns { string }
- */
-declare function callString(target: any, mode?: -1 | 0 | 1): string;
-/**
- * @title 空函数 <空操作; 无操作;>
- */
-declare const noop: () => void;
-
-/**
- * @title 随机生成数字函数
- * @param [start, end] 大小范围
- * @returns {Date} 随机数字结果
- */
-declare function randomRange(min: number, max: number): number;
-/**
- * @title 随机生成RGB颜色
- * @return { string } 随机RGB颜色
- * @example console.log(randomRgb())// 'rgb(255,0,0)'
- */
-declare function randomRgbColor(raw?: boolean): string;
-/**
- * @title 随机生成十六进制颜色
- * @return { string } 随机十六进制颜色
- * @example console.log(randomHexColor()) // '#ff0000'
- */
-declare function randomHexColor(): string;
-/**
- * @title 随机生成时间
- * @param [start, end] 时间范围 (支持/或-分隔, end默认是当前日期)
- * @returns {Date} 随机时间结果
- */
-declare function randomDate(start?: string, end?: string): Date;
-/**
- * @title 随机生成uuid
- *  @returns {string} 32位uuid
- */
-declare function randomUUID(): string;
-
-/**
- * @title [any-rule](https://github.com/any86/any-rule)
- */
-/**
- * @title 必须带端口号的网址(或ip)
- */
-declare const regUriAndPort: RegExp;
-/**
- * @title 网址(URL)
- * @desc https://baike.baidu.com/item/%E9%A1%B6%E7%BA%A7%E5%9F%9F%E5%90%8D#4_1
- * @desc https://baike.baidu.com/item/%E9%A1%B6%E7%BA%A7%E5%9F%9F%E5%90%8D#7
- * @desc 也参考谷歌浏览器的地址栏, 如果输入非字母不会被识别为域名
- */
-declare const regUri: RegExp;
-/**
- * @title 域名(非网址, 不包含协议)
- */
-declare const regDomain: RegExp;
-/**
- * @title ip-v4[:端口]
- */
-declare const regIPV4: RegExp;
-/**
- * @title ip-v6[:端口]
- */
-declare const regIPV6: RegExp;
-/**
- * @title java包名
- */
-declare const regJAVAPackageName: RegExp;
-/**
- * @title mac地址
- */
-declare const regMacAddr: RegExp;
-/**
- * @title 迅雷链接(宽松匹配)
- */
-declare const regThunderEasy: RegExp;
-/**
- * @title ed2k链接(宽松匹配)
- */
-declare const regEd2kEasy: RegExp;
-/**
- * @title 磁力链接(宽松匹配)
- */
-declare const regMagnetEasy: RegExp;
-/**
- * @title 子网掩码(不包含 0.0.0.0)
- */
-declare const regSubnetMask: RegExp;
-/**
- * @title linux"隐藏文件"路径
- */
-declare const regLinuxHideFilePath: RegExp;
-/**
- * @title linux文件路径
- */
-declare const regLinuxFilePath: RegExp;
-/**
- * @title linux文件夹路径
- */
-declare const regLinuxFolderPath: RegExp;
-/**
- * @title window下"文件"路径
- */
-declare const regWindowsFilePath: RegExp;
-/**
- * @title window"文件夹"路径
- */
-declare const regWindowsFolderPath: RegExp;
-/**
- * @title 16进制颜色
- */
-declare const regHexadecimalColor: RegExp;
-/**
- * @title html注释
- */
-declare const regHtmlComments: RegExp;
-/**
- * @title html标签(宽松匹配)
- */
-declare const regHtmlTags: RegExp;
-/**
- * @title md5格式(32位)
- */
-declare const regMD5: RegExp;
-/**
- * @title GUID/UUID
- */
-declare const regUUID: RegExp;
-/**
- * @title 版本号(version)格式必须为X.Y.Z
- * @desc https://semver.org/lang/zh-CN/
- */
-declare const regSemVer: RegExp;
-/**
- * @title 视频(video)链接地址（视频格式可按需增删）
- */
-declare const regVideoUri: RegExp;
-/**
- * @title 图片(image)链接地址（图片格式可按需增删）
- */
-declare const regImageUri: RegExp;
-/**
- * @title base64格式
- */
-declare const regBase64: RegExp;
-/**
- * @title 24小时制时间（HH:mm:ss）
- */
-declare const regHHmmss: RegExp;
-/**
- * @title 12小时制时间（hh:mm:ss）
- */
-declare const reghhmmss: RegExp;
-/**
- * @title 日期(宽松)
- */
-declare const regDateEasy: RegExp;
-/**
- * @title 日期(严谨, 支持闰年判断)
- */
-declare const regDate: RegExp;
-/**
- * @title 可以被moment转化成功的时间 YYYYMMDD HH:mm:ss
- */
-declare const regDateMoment: RegExp;
-/**
- * @title email(邮箱)
- */
-declare const regEmail: RegExp;
-/**
- * @title email(支持中文邮箱)
- */
-declare const regEmailEasy: RegExp;
-/**
- * @title 匹配连续重复的字符
- */
-declare const regRepeat: RegExp;
-/**
- * @title ASCII码表中的全部的特殊字符
- */
-declare const regASCII: RegExp;
-/**
- * @title 中文/汉字
- * // rule: /^[\u4E00-\u9FA5]+$/
- */
-declare const regChineseCharacters: RegExp;
-/**
- * @title 匹配中文汉字和中文标点
- */
-declare const regChineseCharacterAndPoint: RegExp;
-/**
- * @title 中文和数字
- */
-declare const regChineseAndNumber: RegExp;
-/**
- * @title 数字和英文字母组成，并且同时含有数字和英文字母
- */
-declare const regLetterAndNumber: RegExp;
-/**
- * @title 数字和字母组成
- */
-declare const regLetterOrNumber: RegExp;
-/**
- * @title 只包含数字
- */
-declare const regOnlyNumber: RegExp;
-/**
- * @title 英文字母
- */
-declare const regLetters: RegExp;
-/**
- * @title 小写英文字母组成
- */
-declare const regLettersLower: RegExp;
-/**
- * @title 大写英文字母
- */
-declare const regLettersUpper: RegExp;
-/**
- * @title 不能包含字母
- */
-declare const regNotLetter: RegExp;
-/**
- * @title 小数
- */
-declare const regDecimal: RegExp;
-/**
- * @title 正整数，不包含0
- */
-declare const regIntegerPositive: RegExp;
-/**
- * @title 负整数，不包含0
- */
-declare const regIntegerNegative: RegExp;
-/**
- * @title 整数
- */
-declare const regInteger: RegExp;
-/**
- * @title 浮点数
- * // allow "1.23", allow "-0.1", allow "0.00", ban "-0.00", ban "2.", allow "2.0"
- */
-declare const regFloatEasy: RegExp;
-/**
- * @title 浮点数(严格)
- * // allow "1.23", allow "-0.1", ban "2.", ban "2.0"
- */
-declare const regFloat: RegExp;
-/**
- * @title 车牌号(新能源)
- */
-declare const regLicensePlateNE: RegExp;
-/**
- * @title 车牌号(非新能源)
- */
-declare const regLicensePlateLegacy: RegExp;
-/**
- * @title 车牌号(新能源+非新能源)
- */
-declare const regLicensePlateAll: RegExp;
-/**
- * @title 身份证号(1代,15位数字)
- */
-declare const regIdentityCardV1: RegExp;
-/**
- * @title 身份证号(2代,18位数字),最后一位是校验位,可能为数字或字符X
- */
-declare const regIdentityCardV2: RegExp;
-/**
- * @title 身份证号, 支持1/2代(15位/18位数字)
- */
-declare const regIdentityCard: RegExp;
-/**
- * @title 香港身份证
- */
-declare const regIdentityCardHK: RegExp;
-/**
- * @title 澳门身份证
- * @desc https://baike.baidu.com/item/%E6%BE%B3%E9%97%A8%E5%B1%85%E6%B0%91%E8%BA%AB%E4%BB%BD%E8%AF%81/12509098?fr=aladdin#5
- */
-declare const regIdentityCardMO: RegExp;
-/**
- * @title 台湾身份证
- */
-declare const regIdentityCardTWN: RegExp;
-/**
- * @title 护照（包含香港、澳门）
- */
-declare const regPassport: RegExp;
-/**
- * @title 银行卡号（10到30位, 覆盖对公/私账户, 参考[微信支付](https://pay.weixin.qq.com/wiki/doc/api/xiaowei.php?chapter=22_1)）
- */
-declare const regBankCardNo: RegExp;
-/**
- * @title 中国的所有省
- */
-declare const regChineseProvince: RegExp;
-/**
- * @title 手机号(mobile phone)中国(严谨), 根据工信部2019年最新公布的手机号段
- */
-declare const regMobile: RegExp;
-/**
- * @title 手机号(mobile phone)中国(宽松), 只要是13,14,15,16,17,18,19开头即可
- */
-declare const regMobileEasy: RegExp;
-/**
- * @title 手机号(mobile phone)中国(最宽松), 只要是1开头即可, 如果你的手机号是用来接收短信, 优先建议选择这一条
- */
-declare const regMobileEasiest: RegExp;
-/**
- * @title 座机(tel phone)电话(国内),如: 0341-86091234
- */
-declare const regTelephone: RegExp;
-/**
- * @title 火车车次
- */
-declare const regTrainNumber: RegExp;
-/**
- * @title 股票代码(A股)
- */
-declare const regStockCodeA: RegExp;
-/**
- * @title 手机机身码(IMEI)
- */
-declare const regIMEI: RegExp;
-/**
- * @title 统一社会信用代码
- */
-declare const regCreditCode: RegExp;
-/**
-  * @title 统一社会信用代码(宽松匹配)(15位/18位/20位数字/字母)
-  */
-declare const regCreditCodeEasy: RegExp;
-/**
- * @title 邮政编码(中国)
- */
-declare const regPostalCode: RegExp;
-/**
- * @title 数字/货币金额（支持负数、千分位分隔符）
- */
-declare const regAmount: RegExp;
-/**
- * @title 数字/货币金额 (只支持正数、不支持校验千分位分隔符)
- */
-declare const regAmountEasy: RegExp;
-/**
- * @title 大于等于0, 小于等于150, 支持小数位出现5, 如145.5, 用于判断考卷分数
- */
-declare const regExamScore: RegExp;
-/**
- * @title 中文姓名
- */
-declare const regChineseName: RegExp;
-/**
- * @title 英文姓名
- */
-declare const regEnglishName: RegExp;
-/**
- * @title 用户名校验，4到16位（字母，数字，下划线，减号）
- */
-declare const regValidAccountV1: RegExp;
-/**
- * @title 帐号是否合法 (字母开头，允许5-16字节，允许字母数字下划线组合)
- */
-declare const regValidAccountV2: RegExp;
-/**
- * @title qq号格式正确
- */
-declare const regQQ: RegExp;
-/**
- * @title 微信号(wx)，6至20位，以字母开头，字母，数字，减号，下划线
- */
-declare const regWechatID: RegExp;
-/**
- * @title 大写字母，小写字母，数字，特殊符号 `@#$%^&*`~()-+=` 中任意3项密码
- */
-declare const regPasswordV1: RegExp;
-/**
- * @title 密码强度校验，最少6位，包括至少1个大写字母，1个小写字母，1个数字，1个特殊字符
- */
-declare const regPasswordV2: RegExp;
-
-// Type definitions for throttle-debounce 5.0
-
-
-interface CancelOptions {
-    upcomingOnly?: boolean;
-}
-
-interface Cancel {
-    cancel: (options?: CancelOptions) => void;
-}
-
-interface NoReturn<T extends (...args: any[]) => any> {
-    (...args: Parameters<T>): void;
-}
-
-interface ThrottleOptions {
-    noTrailing?: boolean;
-    noLeading?: boolean;
-    debounceMode?: boolean;
-}
-
-interface DebounceOptions {
-    atBegin?: boolean;
-}
-
-type throttle<T extends (...args: any[]) => any> = NoReturn<T> & Cancel;
-
-/**
- * Throttle execution of a function. Especially useful for rate limiting
- * execution of handlers on events like resize and scroll.
- *
- * @param delay
- * A zero-or-greater delay in milliseconds. For event callbacks, values around
- * 100 or 250 (or even higher) are most useful.
- *
- * @param callback
- * A function to be executed after delay milliseconds. The `this` context and
- * all arguments are passed through, as-is, to `callback` when the
- * throttled-function is executed.
- *
- * @param options
- * An object to configure options.
- *
- * @param options.noTrailing
- * Optional, defaults to false. If noTrailing is true, callback will only execute
- * every `delay` milliseconds while the throttled-function is being called. If
- * noTrailing is false or unspecified, callback will be executed one final time
- * after the last throttled-function call. (After the throttled-function has not
- * been called for `delay` milliseconds, the internal counter is reset)
- *
- * @param options.noLeading
- * Optional, defaults to false. If noLeading is false, the first throttled-function
- * call will execute callback immediately. If noLeading is true, the first the
- * callback execution will be skipped. It should be noted that callback will never
- * executed if both noLeading = true and noTrailing = true.
- *
- * @param options.debounceMode If `debounceMode` is true (at begin), schedule
- * `callback` to execute after `delay` ms. If `debounceMode` is false (at end),
- * schedule `callback` to execute after `delay` ms.
- *
- * @return
- * A new, throttled, function.
- */
-declare function throttle<T extends (...args: any[]) => any>(
-    delay: number,
-    callback: T,
-    options?: ThrottleOptions,
-): throttle<T>;
-type debounce<T extends (...args: any[]) => any> = NoReturn<T> & Cancel;
-
-/**
- * Debounce execution of a function. Debouncing, unlike throttling,
- * guarantees that a function is only executed a single time, either at the
- * very beginning of a series of calls, or at the very end.
- *
- * @param delay
- * A zero-or-greater delay in milliseconds. For event callbacks, values around
- * 100 or 250 (or even higher) are most useful.
- *
- * @param callback
- * A function to be executed after delay milliseconds. The `this` context and
- * all arguments are passed through, as-is, to `callback` when the
- * debounced-function is executed.
- *
- * @param options
- * An object to configure options.
- *
- * @param options.atBegin
- * If atBegin is false or unspecified, callback will only be executed `delay`
- * milliseconds after the last debounced-function call. If atBegin is true,
- * callback will be executed only at the first debounced-function call. (After
- * the throttled-function has not been called for `delay` milliseconds, the
- * internal counter is reset).
- *
- * @return
- * A new, debounced function.
- */
-declare function debounce<T extends (...args: any[]) => any>(
-    delay: number,
-    callback: T,
-    options?: DebounceOptions,
-): debounce<T>;
-
-export { assert, callString, debounce, noop, randomDate, randomHexColor, randomRange, randomRgbColor, randomUUID, regASCII, regAmount, regAmountEasy, regBankCardNo, regBase64, regChineseAndNumber, regChineseCharacterAndPoint, regChineseCharacters, regChineseName, regChineseProvince, regCreditCode, regCreditCodeEasy, regDate, regDateEasy, regDateMoment, regDecimal, regDomain, regEd2kEasy, regEmail, regEmailEasy, regEnglishName, regExamScore, regFloat, regFloatEasy, regHHmmss, regHexadecimalColor, regHtmlComments, regHtmlTags, regIMEI, regIPV4, regIPV6, regIdentityCard, regIdentityCardHK, regIdentityCardMO, regIdentityCardTWN, regIdentityCardV1, regIdentityCardV2, regImageUri, regInteger, regIntegerNegative, regIntegerPositive, regJAVAPackageName, regLetterAndNumber, regLetterOrNumber, regLetters, regLettersLower, regLettersUpper, regLicensePlateAll, regLicensePlateLegacy, regLicensePlateNE, regLinuxFilePath, regLinuxFolderPath, regLinuxHideFilePath, regMD5, regMacAddr, regMagnetEasy, regMobile, regMobileEasiest, regMobileEasy, regNotLetter, regOnlyNumber, regPassport, regPasswordV1, regPasswordV2, regPostalCode, regQQ, regRepeat, regSemVer, regStockCodeA, regSubnetMask, regTelephone, regThunderEasy, regTrainNumber, regUUID, regUri, regUriAndPort, regValidAccountV1, regValidAccountV2, regVideoUri, regWechatID, regWindowsFilePath, regWindowsFolderPath, reghhmmss, throttle };