# validation

校验类

# account

# validChinaPhoneNumber

在线运行API

中国手机号格式校验

  • 类型:function
  • 参数:
    参数名 类型 是否可选 默认值 说明
    phoneNumber string - 需要校验的数据
  • 返回值:boolean
  • 示例:
    点击查看代码示例

     
     
     

    import { validChinaPhoneNumber } from "@goodluck/util";
    validChinaPhoneNumber("18268952458"); // -> true
    validChinaPhoneNumber("14165951269"); // -> true
    validChinaPhoneNumber("05925324629"); // -> false
    

# validChinaTelephoneNumber

中国电话格式校验

  • 类型:function
  • 参数:
    参数名 类型 是否可选 默认值 说明
    telephoneNumber string - 需要校验的数据
  • 返回值:boolean
  • 示例:
    点击查看代码示例

     
     
     
     

    import { validChinaTelephoneNumber } from "@goodluck/util";
    validChinaTelephoneNumber("0592-5725632"); // -> true
    validChinaTelephoneNumber("5725632"); // -> true
    validChinaTelephoneNumber("18256218532"); // -> false
    validChinaTelephoneNumber("10086"); // -> false
    

# validCaptchaSMS

手机短信验证码校验

校验规则:纯数字

  • 类型:function
  • 参数:
    参数名 类型 是否可选 默认值 说明
    captcha string - 需要校验的数据
    length number 6 验证码长度
  • 返回值:boolean
  • 示例:
    点击查看代码示例

     
     
     
     

    import { validCaptchaSMS } from "@goodluck/util";
    validCaptchaSMS("654321"); // -> true
    validCaptchaSMS("6245", 4); // -> true
    validCaptchaSMS("abcdef"); // -> false
    validCaptchaSMS("1234567"); // -> false
    

# validMail

邮箱格式校验

  • 类型:function
  • 参数:
    参数名 类型 是否可选 默认值 说明
    mail string - 需要校验的数据
  • 返回值:boolean
  • 示例:
    点击查看代码示例

     
     
     
     

    import { validMail } from "@goodluck/util";
    validMail("service@goodluckchina.net"); // -> true
    validMail("469536842@qq.com"); // -> true
    validMail("www.google.com"); // -> false
    validMail("about@goodluck"); // -> false
    

# validURL

网址URL格式校验

  • 类型:function
  • 参数:
    参数名 类型 是否可选 默认值 说明
    url string - 需要校验的数据
    protocol array ["http", "https"] 网址协议类型
  • 返回值:boolean
  • 示例:
    点击查看代码示例

     
     
     
     

    import { validURL } from "@goodluck/util";
    validURL("https://google.com"); // -> true
    validURL("google.com"); // -> true
    validURL(":google.com"); // -> false
    validURL("//google.com"); // -> false
    

# validTencentQQ

腾讯QQ号校验

  • 类型:function
  • 参数:
    参数名 类型 是否可选 默认值 说明
    qq string - 需要校验的数据
  • 返回值:boolean
  • 示例:
    点击查看代码示例

     
     
     
     

    import { validTencentQQ } from "@goodluck/util";
    validTencentQQ("734596148"); // -> true
    validTencentQQ("10000"); // -> true
    validTencentQQ("456782695216"); // -> false
    validTencentQQ("1000"); // -> false
    

# validPassword

密码格式校验

校验规则:必须是6-20位的大小写英文字母或数字

  • 类型:function
  • 参数:
    参数名 类型 是否可选 默认值 说明
    password string - 需要校验的数据
  • 返回值:boolean
  • 示例:
    点击查看代码示例

     
     
     
     

    import { validPassword } from "@goodluck/util";
    validPassword("abc789wsa"); // -> true
    validPassword("9854545878"); // -> true
    validPassword("qwe12"); // -> false
    validPassword("wqeasd1454qwe1asd4q87w7e454as5d54d"); // -> false
    

# validPasswordPayment

支付密码格式校验

校验规则:必须是6位的数字

  • 类型:function
  • 参数:
    参数名 类型 是否可选 默认值 说明
    password string - 需要校验的数据
  • 返回值:boolean
  • 示例:
    点击查看代码示例

     
     
     

    import { validPasswordPayment } from "@goodluck/util";
    validPasswordPayment("654321"); // -> true
    validPasswordPayment("abcdef"); // -> false
    validPasswordPayment("1234567"); // -> false
    

# validIdNumberChina

中国身份证号校验

  • 类型:function
  • 参数:
    参数名 类型 是否可选 默认值 说明
    idNo string - 需要校验的数据
  • 返回值:boolean
  • 示例:
    点击查看代码示例

     
     
     
     

    import { validIdNumberChina } from "@goodluck/util";
    validIdNumberChina("350505199003076992"); // -> true
    validIdNumberChina("653023200811248910"); // -> true
    validIdNumberChina("350783198610248023"); // -> false
    validIdNumberChina("84514215455464545"); // -> false
    

# validBankNumberLuhn

个人银行卡号校验,Luhn算法

只可校验个人银行卡(信用卡、储蓄卡),不适用于校验企业对公账号。

  • 类型:function
  • 参数:
    参数名 类型 是否可选 默认值 说明
    cardNo string - 需要校验的数据
  • 返回值:boolean
  • 示例:
    点击查看代码示例

     
     
     
     
     

    import { validBankNumberLuhn } from "@goodluck/util";
    validBankNumberLuhn("6227002470170278192"); // -> true
    validBankNumberLuhn("6222330006432199"); // -> true
    validBankNumberLuhn("45641880010010"); // -> true
    validBankNumberLuhn("6456812548886515483"); // -> false
    validBankNumberLuhn("6225758888888888"); // -> false
    

# validChinaBusinessLicenseCode

中国营业执照注册号(统一社会信用代码)校验

  • 类型:function
  • 参数:
    参数名 类型 是否可选 默认值 说明
    code string - 需要校验的数据
    only18 boolean false 是否只允许18位的

注册号分为15位或18位,15位是旧版,18位是新版。

  • 返回值:boolean
  • 示例:
    点击查看代码示例

     
     
     
     

    import { validChinaBusinessLicenseCode } from "@goodluck/util";
    validChinaBusinessLicenseCode("91350200MA348TAW4J"); // -> true
    validChinaBusinessLicenseCode("120110000116519"); // -> true
    validChinaBusinessLicenseCode("91350200ma348taw4j"); // -> false
    validChinaBusinessLicenseCode("9156823WD6V69WA91L"); // -> false
    

# code

# validBarcodeEAN13

EAN13条码格式校验

  • 类型:function
  • 参数:
    参数名 类型 是否可选 默认值 说明
    code string - EAN13条码
  • 返回值:boolean
  • 示例:
    点击查看代码示例

     
     

    import { validBarcodeEAN13 } from "@goodluck/util";
    validBarcodeEAN13("6903254300015"); // -> true
    validBarcodeEAN13("6924728645689"); // -> false
    

# currency

# validCurrencyAmount

货币金额校验,最多带两位小数

  • 类型:function
  • 参数:
    参数名 类型 是否可选 默认值 说明
    amount string - 需要校验的数据
  • 返回值:boolean
  • 示例:
    点击查看代码示例

     
     
     
     

    import { validCurrencyAmount } from "@goodluck/util";
    validCurrencyAmount("12123"); // -> true
    validCurrencyAmount("12123.21"); // -> true
    validCurrencyAmount("12123.2165"); // -> false
    validCurrencyAmount("五十六"); // -> false
    

# math

# validInteger

整数校验

  • 类型:function
  • 参数:
    参数名 类型 是否可选 默认值 说明
    number numberstring - 需要校验的数据
  • 返回值:boolean
  • 示例:
    点击查看代码示例

     
     
     

    import { validInteger } from "@goodluck/util";
    validInteger(213456); // -> true
    validInteger(-213456); // -> true
    validInteger("213456"); // -> true
    

# validPositiveInteger

正整数校验

  • 类型:function
  • 参数:
    参数名 类型 是否可选 默认值 说明
    number numberstring - 需要校验的数据
  • 返回值:boolean
  • 示例:
    点击查看代码示例

     
     
     

    import { validPositiveInteger } from "@goodluck/util";
    validPositiveInteger(213456); // -> true
    validPositiveInteger(-213456); // -> false
    validPositiveInteger("213456"); // -> true
    

# name

# validNickname

昵称校验

校验规则:4-20个字符,可由中英文、数字、“-”、“_”组成

  • 类型:function
  • 参数:
    参数名 类型 是否可选 默认值 说明
    nickname string - 需要校验的数据
  • 返回值:boolean
  • 示例:
    点击查看代码示例

     
     
     
     

    import { validNickname } from "@goodluck/util";
    validNickname("葫芦娃救爷爷"); // -> true
    validNickname("Ronaldo1985"); // -> true
    validNickname("★亚里士多德★"); // -> false
    validNickname("《精灵之王》"); // -> false
    

# validName

人名校验

校验规则:必须是汉字或英文字母

  • 类型:function
  • 参数:
    参数名 类型 是否可选 默认值 说明
    name string - 需要校验的数据
  • 返回值:boolean
  • 示例:
    点击查看代码示例

     
     
     
     

    import { validName } from "@goodluck/util";
    validName("李东浩"); // -> true
    validName("Ronaldo"); // -> true
    validName("★亚里士多德★"); // -> false
    validName("《精灵之王》"); // -> false
    

# validNameChinese

中国人名校验

校验规则:必须是2-6个汉字

  • 类型:function
  • 参数:
    参数名 类型 是否可选 默认值 说明
    name string - 需要校验的数据
  • 返回值:boolean
  • 示例:
    点击查看代码示例

     
     
     
     

    import { validNameChinese } from "@goodluck/util";
    validNameChinese("李东浩"); // -> true
    validNameChinese("葫芦娃救爷爷"); // -> true
    validNameChinese("Ronaldo"); // -> false
    validNameChinese("《精灵之王》"); // -> false