Is-in-correct-format NPM

is-in-correct-format

Allows you to check whether a given object is in the correct specified format.

Install

$ npm install --save is-in-correct-format

Usage

const isInCorrectFormat = require('is-in-correct-format');
const is = isInCorrectFormat.is;

isInCorrectFormat( {
	a:2
 },
 {
 	a: is.number
 });
//=> true

isInCorrectFormat( {
	a:{
    	b: 3,
        c: 24
    }
 },
 {
 	a: {
    	b: is.number
    }
 },is.number);
//=> true

isInCorrectFormat( {
	a:{
    	b: 3,
        c: [1,2,3]
    }
 },
 {
 	a: {
    	b: is.number
    }
 },is.number);
//=> true because the arrays values all satisfy 'is.number'

API

isInCorrectFormat(input, check, allValues)

input

Type: Object Description: The object being checked whether is in the correct type

Cyclical objects are not allowed.

check

Type: Object Description: Follows the same format as the input object to check whether the given keys are passing the tests specified.

{
	a: is.function,
	b: function( val ) { 
		return val > 10
    },
    c: val => is.function(val) || is.object(val)
}

These are all examples of possibilities in the check object, you can use the helper object is to assist in checking type or define your own checker functions and arrow functions.