feat: Add minItems and maxItems checks for arrays. (#224)

* feat: Add minItems check for arrays. * Add maxItems, too.
thenativeweb · Nov 25, 2020 · 9e70dfa · 9e70dfa
1 parent bb7b737
commit 9e70dfa
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 0 deletions.
diff --git a/lib/Value.ts b/lib/Value.ts
@@ -105,6 +105,24 @@ class Value {
         break;
       }
 
+      case 'minItems': {
+        const { limit } = error.params as Ajv.LimitParams;
+        const actualCount = failingValue.length;
+
+        message = `Array is too short (${actualCount}), minimum ${limit}`;
+
+        break;
+      }
+
+      case 'maxItems': {
+        const { limit } = error.params as Ajv.LimitParams;
+        const actualCount = failingValue.length;
+
+        message = `Array is too long (${actualCount}), maximum ${limit}`;
+
+        break;
+      }
+
       default: {
         // Intentionally left blank.
       }

diff --git a/test/unit/ValueTests.ts b/test/unit/ValueTests.ts
@@ -216,6 +216,40 @@ suite('Value', (): void => {
           });
         }).is.throwing((ex: Error): boolean => ex.message === 'String does not match pattern: ^thenativeweb$ (at value.result).');
       });
+
+      test('throws an error if an array is too short.', async (): Promise<void> => {
+        schema = new Value({
+          type: 'object',
+          properties: {
+            result: { type: 'array', minItems: 1 }
+          },
+          required: [ 'result' ],
+          additionalProperties: false
+        });
+
+        assert.that((): void => {
+          schema.validate({
+            result: []
+          });
+        }).is.throwing((ex: Error): boolean => ex.message === 'Array is too short (0), minimum 1 (at value.result).');
+      });
+
+      test('throws an error if an array is too long.', async (): Promise<void> => {
+        schema = new Value({
+          type: 'object',
+          properties: {
+            result: { type: 'array', maxItems: 1 }
+          },
+          required: [ 'result' ],
+          additionalProperties: false
+        });
+
+        assert.that((): void => {
+          schema.validate({
+            result: [ 23, 42 ]
+          });
+        }).is.throwing((ex: Error): boolean => ex.message === 'Array is too long (2), maximum 1 (at value.result).');
+      });
     });
   });