Add is.array overload that supports asserting array items (#119)

Co-authored-by: Pedro Augusto de Paula Barbosa <[email protected]> Co-authored-by: Giora Guttsait <[email protected]> Co-authored-by: Sindre Sorhus <[email protected]>
sindresorhus · Jul 25, 2020 · 3f93bf2 · 3f93bf2
1 parent e31db97
commit 3f93bf2
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 4 deletions.
diff --git a/readme.md b/readme.md
@@ -93,7 +93,15 @@ Note: `is.number(NaN)` returns `false`. This intentionally deviates from `typeof
 
 #### Built-in types
 
-##### .array(value)
+##### .array(value, assertion?)
+
+Returns true if `value` is an array and all of its items match the assertion (if provided).
+
+```js
+is.array(value); // Validate `value` is an array.
+is.array(value, is.number); // Validate `value` is an array and all of its items are numbers.
+```
+
 ##### .function(value)
 ##### .buffer(value)
 ##### .object(value)

diff --git a/source/index.ts b/source/index.ts
@@ -165,7 +165,18 @@ is.symbol = isOfType<symbol>('symbol');
 is.numericString = (value: unknown): value is string =>
 	is.string(value) && !is.emptyStringOrWhitespace(value) && !Number.isNaN(Number(value));
 
-is.array = Array.isArray;
+is.array = <T = unknown>(value: unknown, assertion?: (value: T) => value is T): value is T[] => {
+	if (!Array.isArray(value)) {
+		return false;
+	}
+
+	if (!assertion) {
+		return true;
+	}
+
+	return value.every(assertion);
+};
+
 is.buffer = (value: unknown): value is Buffer => (value as any)?.constructor?.isBuffer?.(value) ?? false;
 
 is.nullOrUndefined = (value: unknown): value is null | undefined => is.null_(value) || is.undefined(value);
@@ -438,7 +449,7 @@ interface Assert {
 	boolean: (value: unknown) => asserts value is boolean;
 	symbol: (value: unknown) => asserts value is symbol;
 	numericString: (value: unknown) => asserts value is string;
-	array: <T = unknown>(value: unknown) => asserts value is T[];
+	array: <T = unknown>(value: unknown, assertion?: (element: unknown) => asserts element is T) => asserts value is T[];
 	buffer: (value: unknown) => asserts value is Buffer;
 	nullOrUndefined: (value: unknown) => asserts value is null | undefined;
 	object: <Key extends keyof any = string, Value = unknown>(value: unknown) => asserts value is Record<Key, Value>;
@@ -528,7 +539,14 @@ export const assert: Assert = {
 	boolean: (value: unknown): asserts value is boolean => assertType(is.boolean(value), 'boolean', value),
 	symbol: (value: unknown): asserts value is symbol => assertType(is.symbol(value), 'symbol', value),
 	numericString: (value: unknown): asserts value is string => assertType(is.numericString(value), AssertionTypeDescription.numericString, value),
-	array: <T = unknown>(value: unknown): asserts value is T[] => assertType(is.array(value), 'Array', value),
+	array: <T = unknown>(value: unknown, assertion?: (element: unknown) => asserts element is T): asserts value is T[] => {
+		const assert: (condition: boolean, description: string, value: unknown) => asserts condition = assertType;
+		assert(is.array(value), 'Array', value);
+
+		if (assertion) {
+			value.forEach(assertion);
+		}
+	},
 	buffer: (value: unknown): asserts value is Buffer => assertType(is.buffer(value), 'Buffer', value),
 	nullOrUndefined: (value: unknown): asserts value is null | undefined => assertType(is.nullOrUndefined(value), AssertionTypeDescription.nullOrUndefined, value),
 	object: (value: unknown): asserts value is object => assertType(is.object(value), 'Object', value),

diff --git a/test/test.ts b/test/test.ts
@@ -641,6 +641,30 @@ test('is.numericString', t => {
 
 test('is.array', t => {
 	testType(t, 'array', ['emptyArray']);
+
+	t.true(is.array([1, 2, 3], is.number));
+	t.false(is.array([1, '2', 3], is.number));
+
+	t.notThrows(() => {
+		assert.array([1, 2], assert.number);
+	});
+
+	t.throws(() => {
+		assert.array([1, '2'], assert.number);
+	});
+
+	t.notThrows(() => {
+		const x: unknown[] = [1, 2, 3];
+		assert.array(x, assert.number);
+		x[0].toFixed(0);
+	});
+
+	t.notThrows(() => {
+		const x: unknown[] = [1, 2, 3];
+		if (is.array<number>(x, is.number)) {
+			x[0].toFixed(0);
+		}
+	});
 });
 
 test('is.function', t => {