sane-object

0.0.3 • Public • Published

sane-object

Validates an object against a list of parameters:

  • keys: max number of total keys in object (and nested objects)
  • depth: max depth in the object
  • keyLength: max number of characters in a key (or nested object keys)
  • types: allowed types in the objects values (or nested object values)
    • number
    • string
    • boolean
    • null
    • undefined

Installation

$ npm install sane-object

API

var sane = require('sane-object');
var company = {
    contacts: [
        {
            name: 'Blanca Benson',
            phone: {
                home: '+1 (850) 515-3813',
            },
            address: [
                {
                    home: '661 Congress Street',
                }
            ],
        },
    ],
    company: {
        name: 'SOPRANO',
        address: {
            office: '754 Furman Street',
        },
    }
};
 
sane(company, { keys: 12, depth: 4, keyLength: 8, types: ['string'] }); // true
sane(company, { keys: 11 }); // false
sane(company, { depth: 3 }); // false
sane(company, { keyLength: 7 }); // false
sane(company, { types: [] }); // false
 

License

MIT © René Nielsen & Thomas Jensen @ src.agency

Readme

Keywords

none

Package Sidebar

Install

npm i sane-object

Weekly Downloads

0

Version

0.0.3

License

MIT

Last publish

Collaborators

  • thomas-jensen
  • renenielsen