mm_check 1.4.8 → 1.5.0

package/README.md

@@ -1,2 +1,220 @@
-# mm_check
- 这是超级美眉check参数验证模块，用于验证参数是否正确
+# mm_check
+
+这是超级美眉check参数验证模块，用于验证参数是否正确。本模块提供了一个强大的参数验证类，可以对各种类型的参数进行验证，包括字符串、数字、布尔值、数组和对象等。
+
+## 安装
+
+```bash
+npm install mm_check
+```
+
+## 基本使用
+
+```javascript
+const Check = require('mm_check');
+
+// 创建验证实例
+const check = new Check({
+    name: "username",    // 参数名
+    title: "用户名",    // 参数介绍名
+    type: "string",     // 参数类型
+    string: {
+        notEmpty: true,   // 非空验证
+        min: 3,           // 最小长度
+        max: 20          // 最大长度
+    }
+});
+
+// 验证参数
+const result = check.run("test_user");
+console.log(result);  // 如果验证通过返回null，否则返回错误信息
+```
+
+## 参数配置说明
+
+### 基础配置
+
+- `name`: 参数名称
+- `title`: 参数介绍名
+- `type`: 参数类型，支持 string、number、bool、dateTime、object、array
+- `splitter`: 分隔符号，用于查询时判断多个传参，默认为 "|"
+- `default`: 默认值
+
+### 字符串验证配置 (string)
+
+```javascript
+string: {
+    notEmpty: false,      // 是否非空
+    min: 0,               // 最小长度
+    max: 0,               // 最大长度
+    range: [],            // 长度范围，例：[6, 20]
+    regex: "",           // 正则表达式
+    identical: "",       // 验证与某个参数值是否相同
+    different: "",       // 验证与某个参数值是否不同
+    extension: "",       // 后缀名，多个用"|"分隔
+    format: ""           // 格式验证：email、url、date、dateISO、number、digits、phone
+}
+```
+
+### 数值验证配置 (number)
+
+```javascript
+number: {
+    min: 0,               // 最小值
+    max: 0,               // 最大值
+    range: []             // 数值范围，例：[0, 100]
+}
+```
+
+### 数组验证配置 (array)
+
+```javascript
+array: {
+    min: 0,               // 最小成员数
+    max: 0,               // 最大成员数
+    range: [],            // 成员数范围
+    type: "",            // 成员类型：string、number、object
+    object: []            // 成员为对象时的验证规则
+}
+```
+
+## 使用示例
+
+### 1. 字符串验证
+
+```javascript
+const userCheck = new Check({
+    name: "username",
+    title: "用户名",
+    type: "string",
+    string: {
+        notEmpty: true,
+        min: 3,
+        max: 20,
+        regex: "^[a-zA-Z0-9_]+$"  // 只允许字母、数字和下划线
+    }
+});
+
+console.log(userCheck.run(""));           // 用户名(username) 不能为空
+console.log(userCheck.run("ab"));         // 用户名(username) 最少需要输入 3 个字符
+console.log(userCheck.run("user@123"));   // 用户名(username) 格式不正确
+```
+
+### 2. 数值验证
+
+```javascript
+const ageCheck = new Check({
+    name: "age",
+    title: "年龄",
+    type: "number",
+    number: {
+        min: 0,
+        max: 120
+    }
+});
+
+console.log(ageCheck.run(150));  // 年龄(age) 请输入不大于 120 的数值
+console.log(ageCheck.run(-1));   // 年龄(age) 请输入不小于 0 的数值
+```
+
+### 3. 数组验证
+
+```javascript
+const tagsCheck = new Check({
+    name: "tags",
+    title: "标签",
+    type: "array",
+    array: {
+        min: 1,
+        max: 5,
+        type: "string"
+    }
+});
+
+console.log(tagsCheck.run([]));              // 标签(tags) 数组的成员数不小于 1 个
+console.log(tagsCheck.run([1, 2, 3]));       // 数组成员数据类型不正确, 应为string型
+```
+
+### 4. 对象验证
+
+```javascript
+const userInfoCheck = new Check({
+    name: "userInfo",
+    title: "用户信息",
+    type: "object",
+    object: [
+        {
+            name: "name",
+            title: "姓名",
+            type: "string",
+            string: {
+                notEmpty: true
+            }
+        },
+        {
+            name: "age",
+            title: "年龄",
+            type: "number",
+            number: {
+                min: 0,
+                max: 120
+            }
+        }
+    ]
+});
+
+console.log(userInfoCheck.run({
+    name: "",
+    age: 150
+}));  // 属性 -> 姓名(name) 不能为空
+```
+
+## 错误提示配置
+
+可以通过 `lang` 方法自定义错误提示信息：
+
+```javascript
+check.lang({
+    notEmpty: "字段不能为空",
+    minLength: "长度不能小于 {0} 个字符",
+    maxLength: "长度不能超过 {0} 个字符",
+    // ... 其他提示信息
+});
+```
+
+## API 参考
+
+### Check 类
+
+#### 构造函数
+
+- `constructor(param)`: 创建一个新的验证实例
+  - `param`: 验证配置对象
+
+#### 实例方法
+
+- `run(value, [config])`: 验证值是否正确
+  - `value`: 要验证的值
+  - `config`: 可选的验证配置，默认使用构造函数的配置
+  - 返回：验证通过返回null，否则返回错误信息
+
+- `lang(obj)`: 获取或设置错误提示
+  - `obj`: 设置的提示对象，为空则获取当前提示
+  - 返回：错误提示集合
+
+- `msg(key, v1, v2)`: 获取错误提示
+  - `key`: 语言包键
+  - `v1`: 替换的词1
+  - `v2`: 替换的词2
+  - 返回：错误提示语句
+
+## 注意事项
+
+1. 使用前需要先安装 `mm_expand` 模块，因为本模块依赖于它。
+2. 验证失败时返回的错误信息会自动包含参数名和标题。
+3. 支持链式验证，可以同时设置多个验证规则。
+4. 对于数组和对象的验证，支持递归验证其成员或属性。
+
+## 许可证
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mm_check",
-    "version": "1.4.8",
+    "version": "1.5.0",
     "description": "这是超级美眉check参数验证模块，用于验证参数是否正确",
     "main": "index.js",
     "scripts": {
@@ -26,6 +26,6 @@
     },
     "homepage": "https://github.com/qiuwenwu/mm_check#readme",
     "dependencies": {
-        "mm_expand": "^1.7.1"
+        "mm_expand": "^1.8.3"
     }
 }