pixiu-number-toolkit
Version:
A collection of number utilities.
319 lines (316 loc) • 13.2 kB
TypeScript
import { R as RegexOptions } from '../common.d-B6RfkedC.js';
/**
* 判断是否为千分位格式
* @param value 要判断的字符串
* @param options
* @returns 如果value为千分位格式,返回true;否则返回false。
*/
declare function isValidThousandSeparatedNumber(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为纯数字
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是纯数字时返回 true,否则返回 false
*/
declare function isValidNumber(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为正整数
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是正整数时返回 true,否则返回 false
*/
declare function isValidPositiveInteger(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为负整数
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是负整数时返回 true,否则返回 false
*/
declare function isValidNegativeInteger(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为非正整数
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是非正整数时返回 true,否则返回 false
*/
declare function isValidNonPositiveInteger(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为浮点数
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是浮点数时返回 true,否则返回 false
*/
declare function isValidFloat(value: string, options?: RegexOptions): boolean;
/**
* 判断字符串是否为空或只包含空格
* @param {string} value - 待检查的字符串
* @param options
* @returns {boolean} 是空字符串或只包含空格时返回 true,否则返回 false
*/
declare function isValidBlank(value: string, options?: RegexOptions): boolean;
/**
* 判断数组中的所有元素是否都是数字
* @returns {boolean} 如果数组中的所有元素都是数字,返回 true,否则返回 false
* @param array
*/
declare function areAllElementsNumbers(array: any[]): boolean;
/**
* 判断参数是否为数字或字符串数字
* @param {string | number} value - 待检查的参数
* @returns {boolean} 是数字或字符串数字时返回 true,否则返回 false
*/
declare function isValidNumeric(value: string | number): boolean;
/**
* 判断数组中的所有元素是否都是数字或字符串数字
* @returns {boolean} 如果数组中的所有元素都是数字,返回 true,否则返回 false
* @param array
*/
declare function areAllElementsNumeric(array: any[]): boolean;
/**
* 判断是否为正浮点数
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是正浮点数时返回 true,否则返回 false
*/
declare function isValidPositiveFloat(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为负浮点数
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是负浮点数时返回 true,否则返回 false
*/
declare function isValidNegativeFloat(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为非正浮点数
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是非正浮点数时返回 true,否则返回 false
*/
declare function isValidNonPositiveFloat(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为非负浮点数
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是非负浮点数时返回 true,否则返回 false
*/
declare function isValidNonNegativeFloat(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为电子邮件
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是电子邮件时返回 true,否则返回 false
*/
declare function isValidEmail(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为网址
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是网址时返回 true,否则返回 false
*/
declare function isValidIP(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为子网掩码
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是子网掩码时返回 true,否则返回 false
*/
declare function isValidSubnetMask(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为URL
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是URL时返回 true,否则返回 false
*/
declare function isValidURL(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为中文
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是中文时返回 true,否则返回 false
*/
declare function isValidChinese(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为中文姓名
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是中文姓名时返回 true,否则返回 false
*/
declare function isValidChineseName(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为中国邮政编码
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是中国邮政编码时返回 true,否则返回 false
*/
declare function isValidChinesePostalCode(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为中国手机号
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是中国手机号时返回 true,否则返回 false
*/
declare function isValidChineseMobile(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为中国固话号码
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是中国固话号码时返回 true,否则返回 false
*/
declare function isValidChineseTel(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为中国银行卡号
* @param cardNumber - 待检查的参数
* @param options
* @returns {boolean} 是中国银行卡号时返回 true,否则返回 false
*/
declare function isValidChineseBankCard(cardNumber: string, options?: RegexOptions): boolean;
/**
* 判断是否为中国税号
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是中国税号时返回 true,否则返回 false
*/
declare function isValidChineseTaxNumber(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为有效的账户名
* 以字母开头,允许5-16个字节,
* 允许字母、数字和下划线组合
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是有效的账户名时返回 true,否则返回 false
*/
declare function isValidAccount(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为中文字符
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是中文字符时返回 true,否则返回 false
*/
declare function isValidChineseCharacters(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为十进制数(支持科学记数法)
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是十进制数时返回 true,否则返回 false
*/
declare function isValidDecimalScientificNotation(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为英文字母
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是英文字母时返回 true,否则返回 false
*/
declare function isValidEnglishLetter(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为小写英文字母
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是小写英文字母时返回 true,否则返回 false
*/
declare function isValidLowercaseEnglishLetter(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为大写英文字母
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是大写英文字母时返回 true,否则返回 false
*/
declare function isValidUppercaseEnglishLetter(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为十六进制颜色
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是十六进制颜色时返回 true,否则返回 false
*/
declare function isValidHexColor(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为MAC地址
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是MAC地址时返回 true,否则返回 false
*/
declare function isValidMacAddress(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为身份证号码
* @param id 身份证号码
* @param options
* @returns 如果是身份证号码,返回true;否则返回false。
*/
declare function isValidChineseIdCard(id: string, options?: RegexOptions): boolean;
/**
* 判断是否为有效的新能源车牌号
* @param value - 待检查的车牌号
* @param options
* @returns {boolean} 是有效的新能源车牌号时返回 true,否则返回 false
*/
declare function isValidNewEnergyLicensePlate(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为有效的非新能源车牌号
* @param value - 待检查的车牌号
* @param options
* @returns {boolean} 是有效的非新能源车牌号时返回 true,否则返回 false
*/
declare function isValidNonNewEnergyLicensePlate(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为有效的车牌号(包括新能源和非新能源)
* @param value - 待检查的车牌号
* @param options
* @returns {boolean} 是有效的车牌号时返回 true,否则返回 false
*/
declare function isValidLicensePlate(value: string, options?: RegexOptions): boolean;
/**
* 检查字符串是否不包含特殊字符
* @param value - 待检查的字符串
* @param options
* @returns {boolean} 不包含特殊字符时返回 true,否则返回 false
*/
declare function hasNoSpecialCharacters(value: string, options?: RegexOptions): boolean;
/**
* 检查字符串是否包含表情符号
* @param value - 待检查的字符串
* @param options
* @returns {boolean} 包含表情符号时返回 true,否则返回 false
*/
declare function containsEmoji(value: string, options?: RegexOptions): boolean;
/**
* 验证是否为有效的 IPv4 地址
* @param value - 待验证的 IP 地址
* @param options
* @returns {boolean} 是有效的 IPv4 地址时返回 true,否则返回 false
*/
declare function isValidIPv4(value: string, options?: RegexOptions): boolean;
/**
* 验证是否为有效的中国身份证号(一代)
* @param value - 待验证的身份证号
* @param options
* @returns {boolean} 是有效的一代身份证号时返回 true,否则返回 false
*/
declare function isValidChineseIDCard1(value: string, options?: RegexOptions): boolean;
/**
* 验证是否为有效的中国身份证号(二代)
* @param value - 待验证的身份证号
* @param options
* @returns {boolean} 是有效的二代身份证号时返回 true,否则返回 false
*/
declare function isValidChineseIDCard2(value: string, options?: RegexOptions): boolean;
/**
* 判断是否为统一社会信用代码(严格模式)
* @param value - 待检查的参数
* @param options
* @returns {boolean} 是统一社会信用代码时返回 true,否则返回 false
*/
declare function isValidUnifiedSocialCreditIdentifierStrict(value: string, options?: RegexOptions): boolean;
/**
* 验证是否为有效的统一社会信用代码(宽松模式)
* @param value - 待验证的统一社会信用代码
* @param options
* @returns {boolean} 是有效的统一社会信用代码时返回 true,否则返回 false
*/
declare function isValidUnifiedSocialCreditIdentifierLoose(value: string, options?: RegexOptions): boolean;
/**
* 验证是否为有效的文件扩展名
* @param filename - 待验证的文件名
* @param allowedExtensions - 允许的文件扩展名
* @returns {boolean} 是有效的文件扩展名时返回 true,否则返回 false
*/
declare function isValidFileExtension(filename: string, allowedExtensions: string[]): boolean;
export { areAllElementsNumbers, areAllElementsNumeric, containsEmoji, hasNoSpecialCharacters, isValidAccount, isValidBlank, isValidChinese, isValidChineseBankCard, isValidChineseCharacters, isValidChineseIDCard1, isValidChineseIDCard2, isValidChineseIdCard, isValidChineseMobile, isValidChineseName, isValidChinesePostalCode, isValidChineseTaxNumber, isValidChineseTel, isValidDecimalScientificNotation, isValidEmail, isValidEnglishLetter, isValidFileExtension, isValidFloat, isValidHexColor, isValidIP, isValidIPv4, isValidLicensePlate, isValidLowercaseEnglishLetter, isValidMacAddress, isValidNegativeFloat, isValidNegativeInteger, isValidNewEnergyLicensePlate, isValidNonNegativeFloat, isValidNonNewEnergyLicensePlate, isValidNonPositiveFloat, isValidNonPositiveInteger, isValidNumber, isValidNumeric, isValidPositiveFloat, isValidPositiveInteger, isValidSubnetMask, isValidThousandSeparatedNumber, isValidURL, isValidUnifiedSocialCreditIdentifierLoose, isValidUnifiedSocialCreditIdentifierStrict, isValidUppercaseEnglishLetter };