request-guardian 1.0.4 → 1.0.6

package/README.md

@@ -0,0 +1,83 @@
+# Readme for Request-Guardian
+
+`request-guardian` is a middleware function that validates incoming requests against a set of validation rules using `express-validator`. It can be used to ensure that data sent to a server is in the expected format and meets certain criteria. If the validation fails, it returns a 400 error response with an array of validation errors.
+
+## Installation
+
+To install `request-guardian`, use `npm` or `yarn`.
+
+```bash
+npm install request-guardian
+```
+
+```bash
+yarn add request-guardian
+```
+
+## Usage
+
+`request-guardian` is a middleware function that can be used with `Express` applications. To use it, simply require the module and use it as middleware for your routes.
+
+```javascript
+const express = require('express');
+const validate = require('request-guardian');
+
+const app = express();
+
+// use request-guardian middleware
+app.use(validate);
+
+// define your routes
+app.get('/', (req, res) => {
+    // handle request
+});
+
+app.post('/users', (req, res) => {
+    // handle validated request
+});
+```
+
+Validation rules are defined in separate files located in the `utils/validations/index.js` directory. `request-guardian` will look for a file with the same name as the current route and load any validation rules defined within that file.
+
+```javascript
+// utils/validations/index.js
+
+const { body } = require('express-validator');
+
+module.exports = {
+    '/api/authentication/signup': [
+        body('email').isEmail(),
+        body('password').isLength({ min: 8 }),
+    ]
+} ;
+```
+
+
+
+```javascript
+// app.js
+
+const express = require('express');
+const validate = require('request-guardian');
+
+const app = express();
+
+// use request-guardian middleware
+app.use(validate);
+
+// define your routes
+app.get('/', (req, res) => {
+    // handle request
+});
+
+// use request-guardian middleware for a specific route
+app.post('/users', (req, res) => {
+    // handle validated request
+});
+
+app.listen(3000, () => {
+    console.log('Server started on port 3000');
+});
+```
+
+If no validation rules are found for the current route, `request-guardian` will simply pass the request to the next middleware function in the stack.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "request-guardian",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "",
   "main": "index.js",
   "scripts": {