# kkk-validate

**Repository Path**: wunankun/kkk-validate

## Basic Information

- **Project Name**: kkk-validate
- **Description**: No description available
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2019-09-15
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


# kkk-validate 验证器

### 如何使用?

#### 1. npm
```javascript
    npm install kkk-validate //安装包

    import Rule from 'kkk-validate'
    // ----------- or -------------
    const Rule = requere('kkk-validate') //引入
```

####  或下载代码
通过git下载代码, 将kkk-validate.js放入项目目录中
```javascript
    const Rule = require('./kkk-validate.js') //引入
```

#### 2. 使用
```javascript
    //案例1
    // adorn参数是对错误信息的修饰, 可以不填
    // adorn填cancel取消错误信息提示

    // 验证不通过, return掉
    if(Rule.isAllCnChar("kkk", "真实姓名")) return

    //案例2
    console.log(Rule.isMinNumber(9, 10, "金额"))
    //输出 '金额不能小于10
    // 验证不通过, return 掉
    if(Rule.isMinNumber(9, 10, "金额")) return
```

#### 3. 组合验证
```javascript
    const password = "123456"
    const rePassword = "123456"
    // 验证密码格式 + 两次输入是否一致
    // 两个验证都通过返回false, 否则返回错误信息
    Rule.group(Rule.isPassword(password, "密码"), Rule.isRepeat(password, rePassword, "密码"), false)
    
    
```
#### 4. 小程序错误弹窗
```javascript
    //app.js引入
    import Rule from './utils/kkk-validate'

    //onLaunch里面加上
    Rule.showMessage = function(error) {
      wx.showToast({
        title: error,
        icon: 'none',
        duration: 2000
      })
    }
    
```

#### 5. vue错误弹窗
```javascript
    //app.vue引入
    import Rule from 'kkk-validate'

    //beforeMount里面加上
    Rule.showMessage = (error) => {
      this.$message({
        message: error,
        type: "warning",
      });
    }
    
```


# 函数

## 1. 数字方法
<br>

|  名称   |  功能
|  ----  | ----
| isNumber (number, n_flag, adorn) | 验证数字
| isMinNumber (number, min_number, n_flag, adorn) | 验证数值最小范围
| isMaxNumber (number, max_number, n_flag, adorn) | 验证数值最大范围
| isMinMaxNumber (number, min_number, max_number, n_flag, adorn) | 验证数值范围
| isNumberSL (number, max_length, adorn) | 验证x位小数
<br>

### 参数
<br>

| 名称 | 必填 | 默认值 | 类型 | 参数说明
| --- | --- | --- | --- | ---
| number | 是 |  | string\number | 被验证值
| n_flag | 否 | true | boolean | 为true验证包含小数<br>false只能验证整数,小数报错
| adorn | 否 |  | string | 错误提示修饰
| min_number | 是 |  | number | 最小数值范围
| max_number | 是 |  | number | 最大数值范围
<br>

## 2. 字符串方法
<br>

|  名称   |  功能
|  ----  | ----
| isMinLength (string, min_length, adorn) | 验证字符串最小长度
| isMaxLength (string, max_length, adorn) | 验证字符串最大长度
| isLength (string, min_length, max_length, adorn) | 验证字符串长度
| isNull (string, adorn)| 验证空字符串
| isSpace (string, adorn) | 验证包含空格
| isNoCnChar (string, adorn) | 验证包含汉字
| isAllCnChar (string, adorn) | 验证全为汉字
| isEnNumUline (string, adorn) | 验证英文 数字 下划线
<br>

### 参数
<br>

| 名称 | 必填 | 默认值 | 类型 | 参数说明
| --- | --- | --- | --- | ---
| string | 是 |  | string\number | 被验证值
| adorn | 否 |  | string | 错误提示修饰
| min_length | 是 |  | number | 最小长度
| max_length | 是 |  | number | 最大长度
<br>

## 3. 格式验证
<br>

|  名称   |  功能
|  ----  | ----
| isEmail (string) | 验证邮箱格式
| isUrl (string) | 验证url格式
| isPhone (string) | 验证手机号格式
| isIdCard (string) | 验证身份证格式
<br>

### 参数
| 名称 | 必填 | 默认值 | 类型 | 参数说明
| --- | --- | --- | --- | ---
| string | 是 |  | string\number | 被验证值
<br>

## 4. 其他验证
<br>

|  名称   |  功能
|  ----  | ----
| isPassword (data, p_min, p_max, adorn) | 验证密码格式
| isRepeat (data, re_data, adorn) | 重复验证
| group (fn, ... , arr_flag) | 组合验证
<br>

### 参数
| 名称 | 必填 | 默认值 | 类型 | 参数说明
| --- | --- | --- | --- | ---
| data | 是 |  | string\number | 被验证值
| adorn | 否 |  | string | 错误提示修饰
| p_min | 否 | 6 | number | 最小长度
| p_max | 否 | 16 | number | 最大长度
| fn | 是 |  | function | 验证函数
| arr_flag | 否 | true | boolean | 为true验证不通过,停止后面的验证<br>false遇到错误继续验证,以数组形式返回错误信息