djsv

3.0.5 • Public • Published

jsonschema-validate-default

Build Status Coverage Status

just a tiny libary based on jsonschema libary that allows you to test if your object is valid and if so to combine it with your deafults data

usage example

lazy

const validate = require('djsv');
 
// create your schema
const json = {
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "default": "id",
            "required": true
        },
        "age": {
            "default": 30,
            "type": "integer"
        }
    }
}
 
 let validObject = validate(json,{id:"maty"}) // validObject.instance => {id:"maty",age:30}
 let validObject = validate(json,{id:"maty",age:20}) // validObject.instance => {id:"maty",age:20}
 let validObject = validate(json,{age:20}) //=> {id:"maty",age:20} => error:{valid:false, errorDescription:"id is required"}
 let validObject = validate(json,{id:123456}) //=> error:{valid:false, errorDescription:"id is not a string error "}

with schema initiation before

 
let validateWithSchema = validate(json);
let obj= { id: "12345", info: { age: 6 } };
console.log(JSON.stringify(validateWithSchema(obj).instance));

ignore null option

ignorenull option allows you to set the default param in the return object although the value is defiend

 
validateWithSchema = validate(json);
console.log(JSON.stringify(validateWithSchema({ id: "12345", info: { age: 6, familyName: null } }).instance)) //=> {"id":"12345","info":{"age":6,"familyName":null}}
console.log(JSON.stringify(validateWithSchema({ id: "12345", info: { age: 6, familyName: null } }, { ignoreNull:true }).instance)) //=>{"id":"12345","info":{"age":6,"familyName":"unknown"}}
 

Package Sidebar

Install

npm i djsv

Weekly Downloads

1

Version

3.0.5

License

MIT

Unpacked Size

11.2 kB

Total Files

7

Last publish

Collaborators

  • maty21
  • nassih