return the missing field key

Author: algo7

README.md

@@ -62,13 +62,33 @@ Note: 0 does count as a valid input.
 
 > Default Error Messages:
 
-1. Requests with an empty body will be met with a **400** and the message: `{ msg: 'The request body is empty!'}`.
+1. Requests with an empty body will be met with a **400** and the message:
 
-2. Request with empty fields in the body will be met with a **400** and the message: `{msg:'Some fields are missing!'}`.
+```javascript
+{
+  msg: 'The request body is empty!';
+}
+```
+
+2. Request with empty fields in the body will be met with a **400** and the message:
+
+```javascript
+{
+  msg: 'The request body is empty!',
+  field:'key of the missing field'
+}
+```
+
+```javascript
+//supressFieldKey=true
+{
+  msg: 'The request body is empty!',
+}
+```
 
 You can specify the middleware to skip the check for **GET** requests in the config option.
 
-Custom error message for each scenario above can also be set like the example below:
+Custom error message for each scenario above and whether to supress the filed key can be specified like the example below:
 
 ```javascript
 //Dependencies
@@ -97,6 +117,7 @@ app.use(
     checkGet: true, //Wether to check the GET requests or not
     emptyBodyMsg: 'Err Msg 1', //Custom msg for empty body
     emptyFieldMsg: 'Err Msg 2', //Custom msg for missing fields
+    supressFieldKey = false, //To supress the key of the missing field
   }),
 );
 

app.js

@@ -84,6 +84,7 @@ const emptyInputCheck = ({
     checkGet = true,
     emptyBodyMsg = 'The request body is empty!',
     emptyFieldMsg = 'Some fields are missing!',
+    supressFieldKey = false,
 } = {}) => {
 
     return (req, res, next) => {
@@ -102,7 +103,6 @@ const emptyInputCheck = ({
             }
         }
 
-
         //Deconstruct the request to get the body out
         const { body, } = req;
 
@@ -116,6 +116,7 @@ const emptyInputCheck = ({
         //Array for storing non-0 values
         let checkZ = [];
         let zArray = [];
+        let KeyArray = [];
 
         //Extract the value from the request body
         for (const key in body) {
@@ -124,6 +125,7 @@ const emptyInputCheck = ({
 
             if (element !== 0) {
                 checkZ.push(element);
+                KeyArray.push(key);
             }
 
             if (element === 0) {
@@ -140,14 +142,26 @@ const emptyInputCheck = ({
         //Check for falsy values in the array without 0s
         for (let index = 0; index < checkZ.length; index++) {
             const nonZinput = checkZ[index];
+            const nonZinputKey = KeyArray[index];
 
             //Return false if there is any falsy value
-            if (!nonZinput) {
+            if (!nonZinput && supressFieldKey === false) {
+                res.status(400).json({
+                    msg: emptyFieldMsg,
+                    field: nonZinputKey,
+                });
+                return;
+            }
 
-                res.status(400).json({ msg: emptyFieldMsg, });
+            //Supress field key
+            if (!nonZinput) {
+                res.status(400).json({
+                    msg: emptyFieldMsg,
+                });
                 return;
             }
 
+
         }
 
         return next();

test/main.test.js

@@ -57,7 +57,6 @@ describe('Testing the Input Validation Module', () => {
         });
     });
 
-
     const request = {
         method: '',
         url: 'http://localhost:5003/',
@@ -109,11 +108,13 @@ describe('Testing the Input Validation Module', () => {
                 testField: 'test_data',
                 testField1: '',
             };
-            expect.assertions(1);
+            expect.assertions(2);
             return axios(request)
                 .catch(err => {
                     const errMsg = err.response.data.msg;
+                    const missingField = err.response.data.field;
                     expect(errMsg).toBe('Some fields are missing!');
+                    expect(missingField).toBe('testField1');
                 });
         });
     });
@@ -162,11 +163,13 @@ describe('Testing the Input Validation Module', () => {
                 testField: 'test_data',
                 testField1: '',
             };
-            expect.assertions(1);
+            expect.assertions(2);
             return axios(request)
                 .catch(err => {
                     const errMsg = err.response.data.msg;
+                    const missingField = err.response.data.field;
                     expect(errMsg).toBe('Some fields are missing!');
+                    expect(missingField).toBe('testField1');
                 });
         });
     });