t-comm/es/validate/validate.d.ts

专业、稳定、纯粹的工具库

/**
 * 判断是否外部资源
 * @param {string} path
 * @returns {Boolean}
 * @example
 * ```ts
 * isExternal('http://baidu.com'); // true
 * isExternal('mailto:a@b.com'); // true
 * isExternal('tel:10086'); // true
 * isExternal('ttt'); // false
 * ```
 */
export declare function isExternal(path: string): boolean;
/**
 * 判断是否URL
 * @param {string} url
 * @returns {Boolean}
 * @example
 * ```ts
 * validURL('http://baidu.com'); // true
 * validURL('https://www.google.com'); // true
 * validURL('ftp://192.168.1.1'); // true
 * validURL('baidu.com'); // false
 * validURL('htp://test.com'); // false
 * validURL(''); // false
 * ```
 */
export declare function validURL(url: string): boolean;
/**
 * 判断是否小写
 * @param {string} str
 * @returns {Boolean}
 * @example
 * ```ts
 * validLowerCase('abc'); // true
 * validLowerCase('aBc'); // false
 * validLowerCase('abc123'); // false
 * validLowerCase(''); // false
 * ```
 */
export declare function validLowerCase(str: string): boolean;
/**
 * 判断是否大写
 * @param {string} str
 * @returns {Boolean}
 * @example
 * ```ts
 * validUpperCase('ABC'); // true
 * validUpperCase('ABc'); // false
 * validUpperCase(''); // false
 * ```
 */
export declare function validUpperCase(str: string): boolean;
/**
 * 判断是否字母字符串
 * @param {string} str
 * @returns {Boolean}
 * @example
 * ```ts
 * validAlphabets('abcABC'); // true
 * validAlphabets('abc123'); // false
 * validAlphabets('abc def'); // false
 * ```
 */
export declare function validAlphabets(str: string): boolean;
/**
 * 判断是否合法邮箱地址
 * @param {string} email
 * @returns {Boolean}
 * @example
 * ```ts
 * validEmail('test@example.com'); // true
 * validEmail('user.name@domain.co'); // true
 * validEmail('test'); // false
 * validEmail('@example.com'); // false
 * validEmail('test@'); // false
 * ```
 */
export declare function validEmail(email: string): boolean;
/**
 * 判断是否字符串
 * @param {string} str
 * @returns {Boolean}
 * @example
 * ```ts
 * isString('hello'); // true
 * isString(''); // true
 * isString(123); // false
 * isString(null); // false
 * isString(undefined); // false
 * isString([]); // false
 * ```
 */
export declare function isString(str: any): boolean;
/**
 * 判断是否数组
 * @param {Array} arg
 * @returns {Boolean}
 * @example
 * ```ts
 * isArray([] as any); // true
 * isArray([1, 2, 3] as any); // true
 * isArray('hello'); // false
 * isArray(123 as any); // false
 * ```
 */
export declare function isArray(arg: string): boolean;
/**
 * 判断是否合法的QQ号码
 * @param {String} qq 待检测的qq号
 * @example
 * ```ts
 * isQQNumber(777777); // true
 * isQQNumber('ddd'); // false
 * isQQNumber('1234'); // false  // 少于 5 位
 * isQQNumber('12345678901'); // false  // 超过 10 位
 * isQQNumber('01234567'); // false  // 0 开头
 * ```
 */
export declare function isQQNumber(qq: any): boolean;
/**
 * 判断是否合法的邮箱号码
 * @param {String} email 待检测的邮箱号码
 * @example
 * ```ts
 * isEmail('test@qq.com'); // true
 * isEmail('user.name@domain.com'); // true
 * isEmail('invalid'); // false
 * isEmail(''); // false
 * ```
 */
export declare function isEmail(email: string): boolean;
/**
 * 判断是否合法的手机号
 * @param {String} phone 待检测的手机号
 * @example
 * ```ts
 * isMobile('13800138000'); // true
 * isMobile('19912345678'); // true
 * isMobile('12345678901'); // false  // 不是 1[3-9] 开头
 * isMobile('1380013800'); // false  // 位数不够
 * isMobile('abc'); // false
 * ```
 */
export declare function isMobile(phone: string): boolean;
/**
 * 判断是否合法的电话号码
 * @param {String} tel 待检测的电话号码
 * @example
 * ```ts
 * isTel('0755-1234567'); // true
 * isTel('12345678'); // true
 * isTel('123'); // false
 * isTel('abc'); // false
 * ```
 */
export declare function isTel(tel: string): boolean;
/**
 * 判断当前操作系统是否为 Windows
 * @returns 如果是 Windows 系统返回 true，否则返回 false
 * @example
 * ```ts
 * if (isWindows()) {
 *   console.log('当前运行在 Windows 系统上');
 * }
 * ```
 */
export declare function isWindows(): boolean;