Rename custom errors to custom error handlers for clarity

ooade · Mar 6, 2020 · c7d363f · c7d363f
1 parent fdb3a95
commit c7d363f
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -94,12 +94,12 @@ const schema: Schema = {
 	}
 };
 
-const customErrors: CustomErrors = {
+const CustomErrorHandlers: CustomErrorHandlers = {
 	domainError: ({ value, domain }) =>
 		`${value} doesn't satify the ${domain} requirement`
 };
 
-const validate = validator(schema, customErrors);
+const validate = validator(schema, CustomErrorHandlers);
 ```
 
 **Props available to the error types:**

diff --git a/__test__/index.test.ts b/__test__/index.test.ts
@@ -1,5 +1,5 @@
 import test from 'tape';
-import validator, { CustomErrors, Schema } from '../src';
+import validator, { CustomErrorHandlers, Schema } from '../src';
 
 const domains = {
 	IS_INTEGER: (value: number) => Number.isInteger(value),
@@ -79,12 +79,12 @@ test('should use custom required error message', t => {
 		}
 	};
 
-	const customErrors: CustomErrors = {
+	const CustomErrorHandlers: CustomErrorHandlers = {
 		requiredError: ({ key }) => `You need to pass the required value for ${key}`
 	};
 
 	try {
-		const validate = validator(schema, customErrors);
+		const validate = validator(schema, CustomErrorHandlers);
 		validate({ height: 2 });
 	} catch (err) {
 		t.equal(
@@ -107,13 +107,13 @@ test('should use custom type error message', t => {
 		}
 	};
 
-	const customErrors: CustomErrors = {
+	const CustomErrorHandlers: CustomErrorHandlers = {
 		typeError: ({ value, type }) =>
 			`You passed the wrong type (${type}) with value (${value})`
 	};
 
 	try {
-		const validate = validator(schema, customErrors);
+		const validate = validator(schema, CustomErrorHandlers);
 		validate({ age: '12', height: 2 });
 	} catch (err) {
 		t.equal(
@@ -137,13 +137,13 @@ test('should use custom domain error message', t => {
 		}
 	};
 
-	const customErrors: CustomErrors = {
+	const CustomErrorHandlers: CustomErrorHandlers = {
 		domainError: ({ value, domain }) =>
 			`${value} doesn't satify the ${domain} requirement`
 	};
 
 	try {
-		const validate = validator(schema, customErrors);
+		const validate = validator(schema, CustomErrorHandlers);
 		validate({ age: -1, height: 2 });
 	} catch (err) {
 		t.equal(

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "yooda",
-	"version": "0.2.2",
+	"version": "0.2.3",
 	"description": "🧘‍♂️600b validation library with custom handlers and messages",
 	"source": "src/index.ts",
 	"main": "build/index.js",

diff --git a/src/index.ts b/src/index.ts
@@ -29,13 +29,16 @@ export interface Schema {
 	[key: string]: SchemaBody;
 }
 
-export type CustomErrors = {
+export type CustomErrorHandlers = {
 	requiredError?: CustomErrorHandler<{ key: string }>;
 	typeError?: CustomErrorHandler<TypeErrorProps>;
 	domainError?: CustomErrorHandler<DomainErrorProps>;
 };
 
-const validator = (schema: Schema, customErrors?: CustomErrors) => {
+const validator = (
+	schema: Schema,
+	CustomErrorHandlers?: CustomErrorHandlers
+) => {
 	const handler: ProxyHandler<Data> = {
 		set(target, key: string, value: any) {
 			const targetSchema = schema[key];
@@ -48,8 +51,8 @@ const validator = (schema: Schema, customErrors?: CustomErrors) => {
 
 			if (typeOf(value) !== type) {
 				throw new TypeError(
-					customErrors?.typeError
-						? customErrors.typeError({
+					CustomErrorHandlers?.typeError
+						? CustomErrorHandlers.typeError({
 								key,
 								type,
 								value: JSON.stringify(value)
@@ -62,8 +65,8 @@ const validator = (schema: Schema, customErrors?: CustomErrors) => {
 				domainArr.forEach(domain => {
 					if (!domain(value)) {
 						throw new Error(
-							customErrors?.domainError
-								? customErrors.domainError({
+							CustomErrorHandlers?.domainError
+								? CustomErrorHandlers.domainError({
 										key,
 										type,
 										value: JSON.stringify(value),
@@ -87,8 +90,8 @@ const validator = (schema: Schema, customErrors?: CustomErrors) => {
 
 			if (required && !data[key]) {
 				throw new Error(
-					customErrors?.requiredError
-						? customErrors.requiredError({ key })
+					CustomErrorHandlers?.requiredError
+						? CustomErrorHandlers.requiredError({ key })
 						: `${key} is required`
 				);
 			}