Installation and Usage
npm i -s cleanbody
- Require package in your JS project.
- Initialize a Cleanbody instance with a schema. (Examples in test.json and below.)
- Call a created function on the instance. It will return true if valid, false if not.
const Cleanbody = ;/*** In your project pass in a valid JS object for a schema to compare against incoming payloads.* In my tests I import a JSON file. You can use `test.json` as an example for that.* You can use a valid JS object if you don't want to import JSON.*/const schema =addUser: // <-- root keys on the schema are what functions you will call later. ex. validate.addUser()email: // <-- each key here is a key on the JSON object you are validatingtype: 'string' // <-- you can include an string array or a string of what type(s) you allow for this valuerequired: true // <-- the key can be required or not required. but if it is defined it must meet all criteriapattern: '' // <-- if the value type is a string and you include a pattern in the schema it will validate ituser:type: 'string'required: true;const validate = schema; // We initialize the instance with a schema// Express app example route with body-parserapp;