feat: implement Array validator

src/lib/Validators/IsArray.validator.ts

@@ -0,0 +1,37 @@
+/** @format */
+
+import { ArrayValidatorInit, ValidatorFunction } from '../../types';
+import { FlotsamValidationError } from '../../utils';
+
+export const IsArray = (validationRules?: ArrayValidatorInit): ValidatorFunction => {
+    const { min, max, items } = validationRules || {};
+    return (value: unknown, propertyName: string) => {
+        if (!Array.isArray(value)) {
+            throw new FlotsamValidationError(
+                `Expected property '${propertyName}' to be of type 'Array'. Found property to be of type '${typeof value}' instead.`
+            );
+        }
+
+        const { length } = value;
+
+        if (min && length < min) {
+            throw new FlotsamValidationError(
+                `Expected property '${propertyName}' to be at least of length '${min}'. Found length '${length}' instead.`
+            );
+        }
+
+        if (max && length > max) {
+            throw new FlotsamValidationError(
+                `Expected property '${propertyName}' to be at max of length '${max}'. Found length '${length}' instead.`
+            );
+        }
+
+        if (items && !value.every((item) => typeof item === items)) {
+            throw new FlotsamValidationError(
+                `Expected property '${propertyName}' to contain only elements of type ${items}`
+            );
+        }
+
+        return true;
+    };
+};

src/types/ArrayValidatorInit.d.ts

@@ -0,0 +1,9 @@
+/** @format */
+
+import type { Primitive } from './Primitive';
+
+export type ArrayValidatorInit = {
+    min?: number;
+    max?: number;
+    items?: Primitive;
+};

src/types/Primitive.d.ts

@@ -1,3 +1,3 @@
 /** @format */
 
-type Primitive = 'string' | 'number' | 'object' | 'function' | 'bigint' | 'symbol' | 'undefined' | 'boolean';
+export type Primitive = 'string' | 'number' | 'object' | 'function' | 'bigint' | 'symbol' | 'undefined' | 'boolean';

src/types/index.d.ts

@@ -16,3 +16,4 @@ export type { FindByProperty } from './FindByProperty';
 export type { ValidatorFunction } from './ValidatorFunction';
 export type { Validator } from './Validator';
 export type { Primitive } from './Primitive';
+export type { ArrayValidatorInit } from './ArrayValidatorInit';