Add documentation and tests for validateAllowingStrings()

Author: DrewImm

src/validation/index.ts

@@ -1,18 +1,30 @@
-import { validateSync } from 'class-validator';
+import { validateSync, ValidationError } from 'class-validator';
 
+/**
+ * Check if a string is an integer (signed/unsigned)
+ *
+ * @param str String to check
+ * @returns Returns true if the string is int
+ */
 export function isIntString(str: string): boolean {
 	return (
 		typeof str === 'string' &&
 		Number.isInteger(Number(str))
 	);
 }
 
-export function validateAllowingStrings(obj: object) {
-	let validationErrors = validateSync(obj, {
+/**
+ * Run validation on a model; allowing ints as strings
+ *
+ * @param obj Object to check
+ * @returns Returns true if the string is int
+ */
+export function validateAllowingStrings(obj: object): ValidationError[] {
+	const validationErrors = validateSync(obj, {
 		skipMissingProperties: true
 	});
 
-	validationErrors = validationErrors.filter(error => {
+	return validationErrors.filter(error => {
 		const constraints = error.constraints;
 
 		if (
@@ -24,6 +36,4 @@ export function validateAllowingStrings(obj: object) {
 
 		return Object.keys(error.constraints).length;
 	});
-
-	return validationErrors;
 }

test/spec/api/validation/validation.spec.ts

@@ -0,0 +1,51 @@
+import { IsInt } from 'class-validator';
+import 'jasmine';
+import { BaseModel } from 'models';
+import { isIntString, validateAllowingStrings } from '../../../../src/validation';
+
+/**
+ * isIntString()
+ * pointyapi/validation
+ */
+describe('[Validation] isIntString()', () => {
+	it('returns true if string is int', () => {
+		for (const test of [ '1', '0', '-1', '123', '-123', '99999999999999']) {
+			expect(isIntString(test)).withContext(test).toBeTrue();
+		}
+	});
+
+	it('returns false if string is not int', () => {
+		for (const test of [ '1a', '0x', '-', '%', 'hello', 'a']) {
+			expect(isIntString(test)).withContext(test).toBeFalse();
+		}
+	});
+});
+
+/**
+ * validateAllowingStrings()
+ * pointyapi/validation
+ */
+class ValidationTestModel {
+	@IsInt()
+	public intprop: number | string = undefined;
+}
+
+describe('[Validation] validateAllowingStrings()', () => {
+	it('can allow strings that are ints', () => {
+		const obj = new ValidationTestModel();
+		obj.intprop = '123';
+		const result = validateAllowingStrings(obj);
+
+		expect(Array.isArray(result)).withContext('returns array').toBeTrue();
+		expect(result.length).withContext('number of errors').toBe(0);
+	});
+
+	it('does not allow strings that are not ints', () => {
+		const obj = new ValidationTestModel();
+		obj.intprop = 'abc';
+		const result = validateAllowingStrings(obj);
+
+		expect(Array.isArray(result)).withContext('returns array').toBeTrue();
+		expect(result.length).withContext('number of errors').toBe(1);
+	});
+});