haw-utils

数据验证

Source:

index.js, line 1

Since:

1.1.0

Methods

(static) isBankCard(value) → {Boolean}

Source:

validator/isBankCard.js, line 24

Since:

1.1.0

检测值是否为银行卡号

Example

isBankCard('6228480402564890018');
// => true

isBankCard('6228480402564890');
// => true

isBankCard('123456789');
// => false

Parameters:

Name	Type	Description
`value`	String	要检测的值

Returns:

值是否为银行卡号

Type: Boolean

(static) isBusinessLicense(value, optionsopt) → {Boolean}

Source:

validator/isBusinessLicense.js, line 63

Since:

3.5.0

See:

GS15—2006 工商行政管理市场主体注册号编制规则

检测值是否为营业执照号，也叫工商注册号。由14位数字本体码和1位数字校验码组成，其中本体码从左至右依次为：6位首次登记机关码、8位顺序码。

Example

isBusinessLicense('310115600985533');
// => true

isBusinessLicense('3101156009');
// => false

isBusinessLicense('3101156009', { loose: true });
// => false

isBusinessLicense('310115600985535');
// => false

isBusinessLicense('310115600985535', { loose: true });
// => true

Parameters:

Name Type Attributes Description

value String 要检测的值

options

Object

配置项

Properties

Name	Type	Attributes	Default	Description
`loose`	Boolean	<optional>	`false`	宽松模式。如果为true，不校验校验位。

Returns:

值是否为营业执照号

Type: Boolean

(static) isChinese(value, optionsopt) → {Boolean}

Source:

validator/isChinese.js, line 81

Since:

1.1.0

See:

4.4 Listing of Characters Covered by the Unihan Database

检测值是否为中文

Example

isChinese('林某某');
// => true

isChinese('林A');
// => false

// 宽松模式，只要包含中文即为true
isChinese('林A', {loose: true});
// => true

isChinese('A林A', {loose: true});
// => true

Parameters:

Name Type Attributes Description

value String 要检测的值

options

Object

配置项

Properties

Name	Type	Attributes	Default	Description
`loose`	Boolean	<optional>	`false`	宽松模式。如果为true，只要包含中文即为true

Returns:

值是否为中文

Type: Boolean

(static) isEmail(value) → {Boolean}

Source:

validator/isEmail.js, line 21

Since:

1.1.0

检测值是否为Email

Example

isEmail('1232@qq.com');
// => true

isEmail('123@');
// => false

Parameters:

Name	Type	Description
`value`	String	要检测的值

Returns:

值是否为Email

Type: Boolean

(static) isIdCard(value) → {Boolean}

Source:

validator/isIdCard.js, line 27

Since:

1.1.0

检测值是否为身份证号

Example

isIdCard('320311770706001');
// => true

isIdCard('130701199310302288');
// => true

isIdCard('130701199310');
// => false

Parameters:

Name	Type	Description
`value`	String	要检测的值

Returns:

值是否为身份证号

Type: Boolean

(static) isIPv4(value) → {Boolean}

Source:

validator/isIPv4.js, line 27

Since:

1.1.0

检测值是否为ipv4

Example

isIPv4('192.168.1.1');
// => true

isIPv4('255.255.255.255');
// => true

isIPv4('256.256.256.256');
// => false

isIPv4('0.0');
// => false

Parameters:

Name	Type	Description
`value`	String	要检测的值

Returns:

值是否为ipv4

Type: Boolean

(static) isIPv6(value) → {Boolean}

Source:

validator/isIPv6.js, line 52

Since:

1.1.0

检测值是否为ipv6

Example

// 冒分十六进制表示法
isIPv6('2001:0DB8:0000:0023:0008:0800:200C:417A');
// => true

// 前导0省略
isIPv6('2001:DB8:0:23:8:800:200C:417A');
// => true

isIPv6('FF01:0:0:0:0:0:0:1101');
// => true

// 0位压缩表示法
isIPv6('FF01::1101');
// => true

isIPv6('::1');
// => true

isIPv6('::');
// => true

isIPv6('0:0:0:0:0:0:0:1');
// => true

isIPv6('0:0:0:0:0:0:0:0');
// => true

// 内嵌IPv4地址表示法
isIPv6('::192.168.1.1');
// => true

isIPv6('::FFFF:192.168.1.1');
// => true

isIPv6('192.168.1.1');
// => false

Parameters:

Name	Type	Description
`value`	String	要检测的值

Returns:

值是否为ipv6

Type: Boolean

(static) isMobile(value) → {Boolean}

Source:

validator/isMobile.js, line 21

Since:

1.1.0

检测值是否为手机号码

Example

isMobile('13000000000');
// => true

isMobile('13000');
// => false

Parameters:

Name	Type	Description
`value`	String	要检测的值

Returns:

值是否为手机号码

Type: Boolean

(static) isPassport(value) → {Boolean}

Source:

validator/isPassport.js, line 23

Since:

1.1.0

See:

中华人民共和国护照#个人资料页

检测值是否为护照号支持普通护照(E*)、外交护照(DE)、公务护照(SE)、公务普通护照(PE)、香港特区护照(K/KJ)、澳门特区护照(MA)

Example

isPassport('E12345678');
// => true

isPassport('abc');
// => false

Parameters:

Name	Type	Description
`value`	String	要检测的值

Returns:

值是否为护照号

Type: Boolean

(static) isPassword(value, optionsopt) → {Boolean}

Source:

validator/isPassword.js, line 39

Since:

1.1.0

检测值是否符合密码强度注意该校验只校验是否存在不同字符(大小写字母、数字、特殊符号)，不判断长度

Example

isPassword('a12345678');
// => true

isPassword('a12345678', {level: 3});
// => false

isPassword('Aa12345678', {level: 3});
// => true

isPassword('Aa12345678', {level: 3, ignoreCase: true});
// => false

isPassword('_Aa12345678', {level: 3, ignoreCase: true});
// => true

// 仅支持 数字、字母、特殊字符，其他字符如中文字符是校验不通过的
isPassword('_Aa一二三45678', {level: 3, ignoreCase: true});
// => false

isPassword(' _Aa12345678', {level: 3, ignoreCase: true});
// => false

Parameters:

Name Type Attributes Description

value String 要检测的值

options

Object

配置项

Properties

Name	Type	Attributes	Default	Description
`level`	Number	<optional>	`2`	密码强度 1-包含一种字符 2-包含两种字符 3-包含三种字符。（大写字母、小写字母、数字、特殊字符）
`ignoreCase`	Boolean	<optional>	`false`	忽略大小写，即大小写字母视为一种字符
`special`	String	<optional>	`-_!@#$%^&*`	特殊字符

Returns:

值是否符合密码强度

Type: Boolean

(static) isPostcode(value) → {Boolean}

Source:

validator/isPostcode.js, line 21

Since:

1.1.0

检测值是否为邮政编码

Example

isPostcode('101111');
// => true

isPostcode('123');
// => false

Parameters:

Name	Type	Description
`value`	String	要检测的值

Returns:

值是否为邮政编码

Type: Boolean

(static) isQQ(value) → {Boolean}

Source:

validator/isQQ.js, line 21

Since:

1.1.0

检测值是否为QQ号

Example

isQQ('12345');
// => true

isQQ('123');
// => false

Parameters:

Name	Type	Description
`value`	String	要检测的值

Returns:

值是否为QQ号

Type: Boolean

(static) isSocialCreditCode(value, optionsopt) → {Boolean}

Source:

validator/isSocialCreditCode.js, line 86

Since:

1.1.0

See:

GB 32100-2015 法人和其他组织统一社会信用代码编码规则

检测值是否为统一社会信用代码，也叫三证合一组织代码。由18位数字和大写字母组成，不使用I、O、Z、S、V。

Example

isSocialCreditCode('91350100M000100Y4A3');
// => true

isSocialCreditCode('91350100M000100Y4AB');
// => false

// 宽松模式，不校验校验位。所以也可以通过
isSocialCreditCode('91350100M000100Y4AB', {loose: true});
// => true

Parameters:

Name Type Attributes Description

value String 要检测的值

options

Object

配置项

Properties

Name	Type	Attributes	Default	Description
`loose`	Boolean	<optional>	`false`	宽松模式。如果为true，不校验校验位。

Returns:

值是否为统一社会信用代码

Type: Boolean

(static) isTelephone(value) → {Boolean}

Source:

validator/isTelephone.js, line 27

Since:

1.1.0

检测值是否为固定电话

Example

isTelephone('22033212');
// => true

isTelephone('021-22033212');
// => true

isTelephone('021-22033212-123');
// => true

isTelephone('13000000000');
// => false

Parameters:

Name	Type	Description
`value`	String	要检测的值

Returns:

值是否为固定电话

Type: Boolean

(static) isUrl(value) → {Boolean}

Source:

validator/isUrl.js, line 32

Since:

3.4.0

检测值是否为url

Example

isUrl('');
// => false

isUrl('8.8.8.8');
// => false

isUrl('http://example.com');
// => true

isUrl('https://example.com:8080');
// => true

isUrl('http://www.example.com/test/123');
// => true

isUrl('http://www.example.com/test/123?foo=bar');
// => true

Parameters:

Name	Type	Description
`value`	String	要检测的值

Returns:

值是否为url

Type: Boolean

(static) isVehicle(value) → {Boolean}

Source:

validator/isVehicle.js, line 21

Since:

1.1.0

检测值是否为车牌号

Example

isVehicle('京L88888');
// => true

isVehicle('333333');
// => false

Parameters:

Name	Type	Description
`value`	String	要检测的值

Returns:

值是否为车牌号

Type: Boolean

(static) isWX(value) → {Boolean}

Source:

validator/isWX.js, line 21

Since:

1.1.0

检测值是否为微信号

Example

isWX('a12345');
// => true

isWX('123');
// => false

Parameters:

Name	Type	Description
`value`	String	要检测的值

Returns:

值是否为微信号

Type: Boolean

Validator

Methods

(static) isBankCard(value) → {Boolean}

Example

Parameters:

Returns:

(static) isBusinessLicense(value, optionsopt) → {Boolean}

Example

Parameters:

Properties

Returns:

(static) isChinese(value, optionsopt) → {Boolean}

Example

Parameters:

Properties

Returns:

(static) isEmail(value) → {Boolean}

Example

Parameters:

Returns:

(static) isIdCard(value) → {Boolean}

Example

Parameters:

Returns:

(static) isIPv4(value) → {Boolean}

Example

Parameters:

Returns:

(static) isIPv6(value) → {Boolean}

Example

Parameters:

Returns:

(static) isMobile(value) → {Boolean}

Example

Parameters:

Returns:

(static) isPassport(value) → {Boolean}

Example

Parameters:

Returns:

(static) isPassword(value, optionsopt) → {Boolean}

Example

Parameters:

Properties

Returns:

(static) isPostcode(value) → {Boolean}

Example

Parameters:

Returns:

(static) isQQ(value) → {Boolean}

Example

Parameters:

Returns:

(static) isSocialCreditCode(value, optionsopt) → {Boolean}

Example

Parameters:

Properties

Returns:

(static) isTelephone(value) → {Boolean}

Example

Parameters:

Returns:

(static) isUrl(value) → {Boolean}

Example

Parameters:

Returns:

(static) isVehicle(value) → {Boolean}

Example

Parameters:

Returns:

(static) isWX(value) → {Boolean}

Example

Parameters:

Returns: