feat: add object rule type

ckpack · Sep 30, 2021 · caeaef0 · caeaef0
1 parent f123301
commit caeaef0
Show file tree

Hide file tree

Showing 3 changed files with 76 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -182,6 +182,28 @@ example
   }
 }
 ```
+
+### object
+If type is `object`, There are the following rules
++ `rule`- An object that validate the properties ot the object
+
+example
+```js
+{
+  people: {
+    type: 'object',
+    rule: {
+      name: 'string',
+      age: {
+        isRequired: false,
+        type: 'int',
+        min: 1,
+        max: 200
+      }
+    }
+  }
+}
+```
 ### custom rule
 
 definition custom rule， example

diff --git a/__test__/parameter.test.ts b/__test__/parameter.test.ts
@@ -4,30 +4,6 @@ import { Parameter } from '../src/parameter';
 describe(__filename, () => {
   test('Parameter', async () => {
     const parameter = new Parameter({});
-    console.log(parameter.validate({
-      password: {
-        type: 'string',
-        regexp: /.{6}/
-      },
-      role: {
-        type: 'enum',
-        enum: ['admin', 'user']
-      },
-      name: {
-        type: 'string',
-        min: 2,
-        max: 20
-      },
-      age: {
-        type: 'int',
-        min: 1,
-        max: 200
-      }
-    }, {
-      password: 'h',
-      name: 'x',
-      age: -10
-    }));
     expect(parameter.validate({
       password: {
         type: 'string',
@@ -236,4 +212,47 @@ describe(__filename, () => {
       someNumber: 2
     })).toEqual(null);
   });
+
+  test('Parameter object', async () => {
+    const parameter = new Parameter();
+    expect(parameter.validate({
+      people: {
+        type: 'object',
+        rule: {
+          name: 'string',
+          age: {
+            isRequired: false,
+            type: 'int',
+            min: 1,
+            max: 200
+          }
+        }
+      }
+    }, {
+      people: {
+        name: 'xiao hong',
+        age: 45
+      }
+    })).toEqual(null);
+
+    expect(parameter.validate({
+      people: {
+        type: 'object',
+        rule: {
+          name: 'string',
+          age: {
+            isRequired: false,
+            type: 'int',
+            min: 1,
+            max: 200
+          }
+        }
+      }
+    }, {
+      people: {
+        name: 'xiao hong',
+        age: 'xxx'
+      }
+    })).toEqual([{ code: 'invalid', field: 'people', message: [{ code: 'invalid', field: 'age', message: 'should be a integer' }] }]);
+  });
 });
diff --git a/src/checkers.ts b/src/checkers.ts
@@ -34,7 +34,8 @@ export const DEF_CHECKERS: {
   boolean: checkFunction,
   enum: checkFunction,
   custom: checkFunction,
-  array: checkFunction
+  array: checkFunction,
+  object: checkFunction,
   [key:string]: checkFunction,
 } = <any>{};
 
@@ -141,12 +142,20 @@ const checkArray = (rule:Rule, value: any) => {
   return errors.length ? errors : null;
 };
 
+const checkObject = function (this:any, rule:Rule, value: any) {
+  if (typeof value !== 'object') {
+    return 'should be a object';
+  }
+  return rule.rule ? this.validate(rule.rule, value) : null;
+};
+
 Object.assign(DEF_CHECKERS, {
   number: checkNumber,
   int: checkInt,
   string: checkString,
   boolean: checkBoolean,
   enum: checkEnum,
   custom: checkCustom,
-  array: checkArray
+  array: checkArray,
+  object: checkObject
 });