Neighbor's Preppy Maltese

    @0x4447/pretzel

    1.0.7 • Public • Published

    🥨 Pretzel

    We created our Pretzel recursive JSON data validation after realizing that there were no npm modules that could recursively validate a JSON object with multiple nested values objects.

    We are aware of Validate.js, but as the author explains, the support for complete object is very basic. We did consider proposing a PR to the project, but the source code turned out to be too hard to rezone about. Thus, Pretzel was born.

    The goal of this tool is not just to handle nested JSON files like this...

    {
    	"company_name": "0x4447",
    	"address": {
    		"street": "42 Life",
    		"state": "TX",
    		"code": 123456,
    		"country": "United States",
    		"contact": {
    			"email": "hello@0x4447.email",
    			"phone_nr": "+1 (555) 555-6666"
    		}
    	},
    	"employs": {
    		"ceo": {
    			"individual": {
    				"first_name": "David",
    				"last_name": "Gatti"
    			},
    			"assistant": {
    				"first_name": "Very",
    				"last_name": "Helpful"
    			}
    		}
    	}
    }

    ...with rules structured this way:

    {
    	company_name: {
    		type: 'string'
    	},
    	address: {
    		street: {
    			type: 'string'
    		},
    		state: {
    			includes: ['AL', 'AK', 'AZ', 'AR', 'CA', 'CO', 'CT', 'DE', 'DC', 'FL', 'GA', 'HI', 'ID', 'IL', 'IN', 'IA', 'KS', 'KY', 'LA', 'ME', 'MD', 'MA', 'MI', 'MN', 'MS', 'MO', 'MT', 'NE', 'NV', 'NH', 'NJ', 'NM', 'NY', 'NC', 'ND', 'OH', 'OK', 'OR', 'PA', 'RI', 'SC', 'SD', 'TN', 'TX', 'UT', 'VT', 'VA', 'WA', 'WV', 'WI', 'WY']
    		},
    		code: {
    			type: 'number'
    		},
    		country: {
    			includes: ['United States', 'Canada']
    		},
    		contact: {
    			email: {
    				type: 'string'
    			},
    			phone_nr: {
    				type: 'string'
    			}
    		}
    	},
    	employs: {
    		ceo: {
    			individual: {
    				first_name: {
    					type: 'string'
    				},
    				last_name: {
    					type: 'string'
    				}
    			},
    			assistant: {
    				first_name: {
    					type: 'string'
    				},
    				last_name: {
    					type: 'string'
    				}
    			}
    		}
    	}
    }

    We also wanted to make the source code as simple to understand as possible. If you check the index.js file, you'll see what we mean. Use it, modify it, learn from it.

    How to Install

    ] npm install @0x4447/pretzel
    

    How to Test

    ] npm run test
    

    How to Require

    let pretzel = require('pretzel');
    

    How to Use

    let pretzel = require('pretzel');
    
    //
    //	RULES
    //
    let rules = {
    	name: {
    		type: "string"
    	}
    };
    
    //
    //	Good DATA
    //
    let good_data = {
    	name: '0x4447'
    };
    
    //
    //	Bad DATA
    //
    let bad_data = {
    	name: 123321
    };
    
    //
    //	1.	Execute validation.
    //
    let good = pretzel(good_data, rules);
    let bad = pretzel(bad_data, rules);
    
    //
    //	2.	Check the validation result.
    //
    console.info(good);
    console.info(bad);

    Rules

    Below is a list of all the rules the module supports at this time.

    Bigger than

    {
    	biggerThan: 5
    }

    Smaller than

    {
    	smallerThan: 5
    }

    Comparison

    {
    	comparison: 1
    }

    Includes

    {
    	includes: [9, '0x4447']
    }

    Regular Expression

    {
    	regexp: '[aAzZ.-]'
    }

    Types

    {
    	type: "string || number || object || array"
    }

    The End

    If you enjoyed this project, please consider giving it a 🌟. And check out our 0x4447 GitHub account, where we have additional resources that you might find useful or interesting.

    Sponsor 🎊

    This project is brought to you by 0x4447 LLC, a software company specializing in build custom solutions on top of AWS. Find out more by following this link: https://0x4447.com or, say hello@0x4447.email.

    Install

    npm i @0x4447/pretzel

    DownloadsWeekly Downloads

    9

    Version

    1.0.7

    License

    MIT

    Unpacked Size

    9.47 kB

    Total Files

    4

    Last publish

    Collaborators

    • davidgatti