objectTrigger a compiler error when a value is not an exact type.
\nTrigger a compiler error when a value is not an exact type.
\nobject\n**Kind**: global namespace \n\n* [vet](#vet) : object\n * [.arrays](#vet.arrays) : object\n * [.isArray](#vet.arrays.isArray) ⇒\n * [.isArrayOf(val)](#vet.arrays.isArrayOf) ⇒\n * [.isLength(len)](#vet.arrays.isLength) ⇒\n * [.booleans](#vet.booleans) : object\n * [.isBoolean(val)](#vet.booleans.isBoolean) ⇒\n * [.isFalse(val)](#vet.booleans.isFalse) ⇒\n * [.isFalsy(val)](#vet.booleans.isFalsy) ⇒\n * [.isTrue(val)](#vet.booleans.isTrue) ⇒\n * [.isTruthy(val)](#vet.booleans.isTruthy) ⇒\n * [.dates](#vet.dates) : object\n * [.isDate(val)](#vet.dates.isDate) ⇒\n * [.isValidDate(val)](#vet.dates.isValidDate) ⇒\n * [.functions](#vet.functions) : object\n * [.accepts(func, validator, message)](#vet.functions.accepts) ⇒\n * [.isFunction(val)](#vet.functions.isFunction) ⇒\n * [.returns(func, validator, message)](#vet.functions.returns) ⇒\n * [.numbers](#vet.numbers) : object\n * [.isBetween(lower, upper)](#vet.numbers.isBetween) ⇒ function\n * [.exclusive](#vet.numbers.isBetween.exclusive) ⇒ function\n * [.inclusive](#vet.numbers.isBetween.inclusive) ⇒ function\n * [.isFinite(val)](#vet.numbers.isFinite) ⇒\n * [.isGreaterThan(bound)](#vet.numbers.isGreaterThan) ⇒ function\n * [.exclusive](#vet.numbers.isGreaterThan.exclusive) ⇒ function\n * [.inclusive](#vet.numbers.isGreaterThan.inclusive) ⇒ function\n * [.isInteger(val)](#vet.numbers.isInteger) ⇒\n * [.isLessThan(bound)](#vet.numbers.isLessThan) ⇒ function\n * [.exclusive](#vet.numbers.isLessThan.exclusive) ⇒ function\n * [.inclusive](#vet.numbers.isLessThan.inclusive) ⇒ function\n * [.isNegative(val)](#vet.numbers.isNegative) ⇒\n * [.isNonZero(val)](#vet.numbers.isNonZero) ⇒\n * [.isNumber(val)](#vet.numbers.isNumber) ⇒\n * [.isPositive(val)](#vet.numbers.isPositive) ⇒\n * [.isZero(val)](#vet.numbers.isZero) ⇒\n * [.objects](#vet.objects) : object\n * [.isInstanceOf(con)](#vet.objects.isInstanceOf) ⇒\n * [.isObject(val)](#vet.objects.isObject) ⇒\n * [.isObjectOf(validator)](#vet.objects.isObjectOf) ⇒\n * [.isShape(schema)](#vet.objects.isShape) ⇒\n * [.isShape.exact(schema)](#vet.objects.isShape.isShape.exact) ⇒\n * [.isShape.partial(schema)](#vet.objects.isShape.isShape.partial) ⇒\n * [.strings](#vet.strings) : object\n * [.isEmpty(val)](#vet.strings.isEmpty) ⇒\n * [.isLength(len)](#vet.strings.isLength) ⇒\n * [.isNotEmpty(val)](#vet.strings.isNotEmpty) ⇒\n * [.isProbablyBase64(val)](#vet.strings.isProbablyBase64) ⇒\n * [.isProbablyDataURL(val)](#vet.strings.isProbablyDataURL) ⇒\n * [.isProbablyEmail(val)](#vet.strings.isProbablyEmail) ⇒\n * [.isProbablyURL(val)](#vet.strings.isProbablyURL) ⇒\n * [.isString(val)](#vet.strings.isString) ⇒\n * [.matches(regex)](#vet.strings.matches) ⇒\n * [.utils](#vet.utils) : object\n * [.assertReact](#vet.utils.assertReact) ⇒\n * [.assert(validator, message)](#vet.utils.assert) ⇒\n * [.equals(eq)](#vet.equals) ⇒\n * [.exists(val)](#vet.exists) ⇒\n * [.isAllOf(...eq)](#vet.isAllOf) ⇒\n * [.isAny(val)](#vet.isAny) ⇒\n * [.isNoneOf(...eq)](#vet.isNoneOf) ⇒\n * [.isNot(validator)](#vet.isNot) ⇒\n * [.isNotNull(val)](#vet.isNotNull) ⇒\n * [.isNotNullOrUndefined(val)](#vet.isNotNullOrUndefined) ⇒\n * [.isNotUndefined(val)](#vet.isNotUndefined) ⇒\n * [.isNull(val)](#vet.isNull) ⇒\n * [.isNullOrUndefined(val)](#vet.isNullOrUndefined) ⇒\n * [.isOneOf(...eq)](#vet.isOneOf) ⇒\n * [.isUndefined(val)](#vet.isUndefined) ⇒\n * [.nullable(validator)](#vet.nullable) ⇒\n * [.optional(validator)](#vet.optional) ⇒\n\n\n* * *\n\n\n\n### vet.arrays : object\n**Kind**: static namespace of [vet](#vet) \n\n* [.arrays](#vet.arrays) : object\n * [.isArray](#vet.arrays.isArray) ⇒\n * [.isArrayOf(val)](#vet.arrays.isArrayOf) ⇒\n * [.isLength(len)](#vet.arrays.isLength) ⇒\n\n\n* * *\n\n\n\n#### arrays.isArray ⇒\nChecks to see if a value is an array\n\n**Kind**: static property of [arrays](#vet.arrays) \n**Returns**: true if the value is an array \n**Params**\n\n- val - the value to check\n\n**Example** \n```javascript\nlet isArray from 'vet/arrays/isArray');\n\nisArray(null); // returns false\nisArray({}); // returns false\n\nisArray([]); // returns true\n```\n\n* * *\n\n\n\n#### arrays.isArrayOf(val) ⇒\nBuilds an array validator that checks the children of the array\n\n**Kind**: static method of [arrays](#vet.arrays) \n**Returns**: a function that returns true if the value is an array, and all of the children pass the validator \n**Params**\n\n- val - the validator function run against the array children\n\n**Example** \n```javascript\nlet isString from 'vet/strings/isString');\nlet isArrayOf from 'vet/arrays/isArrayOf');\n\nlet isStringArray = isArrayOf(isString);\n\nisStringArray(null); // returns false\nisStringArray({}); // returns false\nisStringArray([ 1, 2, 3 ]); // returns false\n\nisStringArray([]); // returns true\nisStringArray([ '1', '2', '3' ]); // returns true\n```\n\n* * *\n\n\n\n#### arrays.isLength(len) ⇒\nConstructor to build an array length validator\n\n**Kind**: static method of [arrays](#vet.arrays) \n**Returns**: a function that returns true if the value is an array of length len \n**Params**\n\n- len - the length the array shouldbe\n\n**Example** \n```javascript\nlet isLength from 'vet/arrays/isLength');\n\nlet isLength3 = isLength(3);\n\nisLength3(null); // returns false\nisLength3({}); // returns false\nisLength3([ 1, 2 ]); // returns false\n\nisLength3([ '1', '2', '3' ]); // returns true\n```\n\n* * *\n\n\n\n### vet.booleans : object\n**Kind**: static namespace of [vet](#vet) \n\n* [.booleans](#vet.booleans) : object\n * [.isBoolean(val)](#vet.booleans.isBoolean) ⇒\n * [.isFalse(val)](#vet.booleans.isFalse) ⇒\n * [.isFalsy(val)](#vet.booleans.isFalsy) ⇒\n * [.isTrue(val)](#vet.booleans.isTrue) ⇒\n * [.isTruthy(val)](#vet.booleans.isTruthy) ⇒\n\n\n* * *\n\n\n\n#### booleans.isBoolean(val) ⇒\nChecks to see if a value is a boolean\n\n**Kind**: static method of [booleans](#vet.booleans) \n**Returns**: true if the value is a boolean \n**Params**\n\n- val - the value to check\n\n\n* * *\n\n\n\n#### booleans.isFalse(val) ⇒\nChecks to see if a value is strictly false\n\n**Kind**: static method of [booleans](#vet.booleans) \n**Returns**: true if the value is strictly false \n**Params**\n\n- val - the value to check\n\n**Example** \n```javascript\nlet isFalse from 'vet/booleans/isFalse');\n\nisFalse(null); // returns false\nisFalse(true); // returns false\n\nisFalse(false); // returns true\n```\n\n* * *\n\n\n\n#### booleans.isFalsy(val) ⇒\nChecks to see if a value is loosely false (falsy)\n\n**Kind**: static method of [booleans](#vet.booleans) \n**Returns**: true if the value is loosely false \n**Params**\n\n- val - the value to check\n\n**Example** \n```javascript\nlet isFalsy from 'vet/booleans/isFalsy');\n\nisFalse(true); // returns false\n\nisFalsy(null); // returns true\nisFalsy(false); // returns true\n```\n\n* * *\n\n\n\n#### booleans.isTrue(val) ⇒\nChecks to see if a value is strictly true\n\n**Kind**: static method of [booleans](#vet.booleans) \n**Returns**: true if the value is strictly true \n**Params**\n\n- val - the value to check\n\n**Example** \n```javascript\nlet isTrue from 'vet/booleans/isTrue');\n\nisTrue(null); // returns false\nisTrue(false); // returns false\n\nisTrue(true); // returns true\n```\n\n* * *\n\n\n\n#### booleans.isTruthy(val) ⇒\nChecks to see if a value is loosely true (truthy)\n\n**Kind**: static method of [booleans](#vet.booleans) \n**Returns**: true if the value loosely true \n**Params**\n\n- val - the value to check\n\n**Example** \n```javascript\nlet isTruthy from 'vet/booleans/isTruthy');\n\nisTruthy(null); // returns false\nisTruthy(false); // returns false\n\nisTruthy({}); // returns true\nisTruthy(true); // returns true\n```\n\n* * *\n\n\n\n### vet.dates : object\n**Kind**: static namespace of [vet](#vet) \n\n* [.dates](#vet.dates) : object\n * [.isDate(val)](#vet.dates.isDate) ⇒\n * [.isValidDate(val)](#vet.dates.isValidDate) ⇒\n\n\n* * *\n\n\n\n#### dates.isDate(val) ⇒\nChecks to see if a value is a Date\n\n**Kind**: static method of [dates](#vet.dates) \n**Returns**: true if the value is a Date \n**Params**\n\n- val - the value to check\n\n**Example** \n```javascript\nlet isDate from 'vet/dates/isDate');\n\nisDate(null); // returns false\nisDate({}); // returns false\n\nisDate(new Date()); // returns true\n```\n\n* * *\n\n\n\n#### dates.isValidDate(val) ⇒\nChecks to see if a value is a valid Date object\n\n**Kind**: static method of [dates](#vet.dates) \n**Returns**: true if the value is a valid Date object \n**Params**\n\n- val - the value to check\n\n**Example** \n```javascript\nlet isValidDate from 'vet/dates/isValidDate');\n\nisValidDate(null); // returns false\nisValidDate({}); // returns false\nisValidDate(new Date(NaN)); // returns false\n\nisValidDate(new Date()); // returns true\n```\n\n* * *\n\n\n\n### vet.functions : object\n**Kind**: static namespace of [vet](#vet) \n\n* [.functions](#vet.functions) : object\n * [.accepts(func, validator, message)](#vet.functions.accepts) ⇒\n * [.isFunction(val)](#vet.functions.isFunction) ⇒\n * [.returns(func, validator, message)](#vet.functions.returns) ⇒\n\n\n* * *\n\n\n\n#### functions.accepts(func, validator, message) ⇒\nWraps a function in a validator which checks its arguments, and throws an error if the arguments are bad.\n\n**Kind**: static method of [functions](#vet.functions) \n**Returns**: a wrapped function that throws an error if the arguments do not pass validation \n**Params**\n\n- func - the function to wrap\n- validator - the validator function. This gets passed the arguments as an array\n- message - an optional message string to pass into the error thrown\n\n\n* * *\n\n\n\n#### functions.isFunction(val) ⇒\nChecks to see if a value is a function\n\n**Kind**: static method of [functions](#vet.functions) \n**Returns**: true if the value is a function \n**Params**\n\n- val - the value to check\n\n**Example** \n```javascript\nlet isFunction from 'vet/functions/isFunction');\n\nisFunction(null); // returns false\nisFunction({}); // returns false\n\nisFunction(function (){}); // returns true\n```\n\n* * *\n\n\n\n#### functions.returns(func, validator, message) ⇒\nWraps a function in a validator which checks its return value, and throws an error if the return value is bad.\n\n**Kind**: static method of [functions](#vet.functions) \n**Returns**: a wrapped function that throws an error if the return value doed not pass validation \n**Params**\n\n- func - the function to wrap\n- validator - the validator function. This gets passed the return value\n- message - an optional message string to pass into the error thrown\n\n\n* * *\n\n\n\n### vet.numbers : object\n**Kind**: static namespace of [vet](#vet) \n\n* [.numbers](#vet.numbers) : object\n * [.isBetween(lower, upper)](#vet.numbers.isBetween) ⇒ function\n * [.exclusive](#vet.numbers.isBetween.exclusive) ⇒ function\n * [.inclusive](#vet.numbers.isBetween.inclusive) ⇒ function\n * [.isFinite(val)](#vet.numbers.isFinite) ⇒\n * [.isGreaterThan(bound)](#vet.numbers.isGreaterThan) ⇒ function\n * [.exclusive](#vet.numbers.isGreaterThan.exclusive) ⇒ function\n * [.inclusive](#vet.numbers.isGreaterThan.inclusive) ⇒ function\n * [.isInteger(val)](#vet.numbers.isInteger) ⇒\n * [.isLessThan(bound)](#vet.numbers.isLessThan) ⇒ function\n * [.exclusive](#vet.numbers.isLessThan.exclusive) ⇒ function\n * [.inclusive](#vet.numbers.isLessThan.inclusive) ⇒ function\n * [.isNegative(val)](#vet.numbers.isNegative) ⇒\n * [.isNonZero(val)](#vet.numbers.isNonZero) ⇒\n * [.isNumber(val)](#vet.numbers.isNumber) ⇒\n * [.isPositive(val)](#vet.numbers.isPositive) ⇒\n * [.isZero(val)](#vet.numbers.isZero) ⇒\n\n\n* * *\n\n\n\n#### numbers.isBetween(lower, upper) ⇒ function\nconstruct a validator to check if a value is between two numbers\n\n**Kind**: static method of [numbers](#vet.numbers) \n**Returns**: function - - a validator function \n**Params**\n\n- lower number - the lower boundary value to check against\n- upper number - the upper boundary value to check against\n\n\n* [.isBetween(lower, upper)](#vet.numbers.isBetween) ⇒ function\n * [.exclusive](#vet.numbers.isBetween.exclusive) ⇒ function\n * [.inclusive](#vet.numbers.isBetween.inclusive) ⇒ function\n\n\n* * *\n\n\n\n##### isBetween.exclusive ⇒ function\n**Kind**: static property of [isBetween](#vet.numbers.isBetween) \n**Returns**: function - - a validator function \n**Params**\n\n- lower number - the lower boundary value to check against\n- upper number - the upper boundary value to check against\n\n\n* * *\n\n\n\n##### isBetween.inclusive ⇒ function\n**Kind**: static property of [isBetween](#vet.numbers.isBetween) \n**Returns**: function - - a validator function \n**Params**\n\n- lower number - the lower boundary value to check against\n- upper number - the upper boundary value to check against\n\n\n* * *\n\n\n\n#### numbers.isFinite(val) ⇒\nChecks to see if a value is a finite number\n\n**Kind**: static method of [numbers](#vet.numbers) \n**Returns**: true if the value is a finite number \n**Params**\n\n- val - the value to check\n\n\n* * *\n\n\n\n#### numbers.isGreaterThan(bound) ⇒ function\nconstruct a validator to check if a value is greater than a number\n\n**Kind**: static method of [numbers](#vet.numbers) \n**Returns**: function - - a validator function \n**Params**\n\n- bound number - the boundary value to check agains\n\n\n* [.isGreaterThan(bound)](#vet.numbers.isGreaterThan) ⇒ function\n * [.exclusive](#vet.numbers.isGreaterThan.exclusive) ⇒ function\n * [.inclusive](#vet.numbers.isGreaterThan.inclusive) ⇒ function\n\n\n* * *\n\n\n\n##### isGreaterThan.exclusive ⇒ function\n**Kind**: static property of [isGreaterThan](#vet.numbers.isGreaterThan) \n**Returns**: function - - a validator function \n**Params**\n\n- bound number - the boundary value to check against\n\n\n* * *\n\n\n\n##### isGreaterThan.inclusive ⇒ function\n**Kind**: static property of [isGreaterThan](#vet.numbers.isGreaterThan) \n**Returns**: function - - a validator function \n**Params**\n\n- bound number - the boundary value to check against\n\n\n* * *\n\n\n\n#### numbers.isInteger(val) ⇒\nChecks to see if a value is an integer\n\n**Kind**: static method of [numbers](#vet.numbers) \n**Returns**: true if the value is an integer \n**Params**\n\n- val - the value to check\n\n\n* * *\n\n\n\n#### numbers.isLessThan(bound) ⇒ function\nconstruct a validator to check if a value is less than a number\n\n**Kind**: static method of [numbers](#vet.numbers) \n**Returns**: function - - a validator function \n**Params**\n\n- bound number - the boundary value to check agains\n\n\n* [.isLessThan(bound)](#vet.numbers.isLessThan) ⇒ function\n * [.exclusive](#vet.numbers.isLessThan.exclusive) ⇒ function\n * [.inclusive](#vet.numbers.isLessThan.inclusive) ⇒ function\n\n\n* * *\n\n\n\n##### isLessThan.exclusive ⇒ function\n**Kind**: static property of [isLessThan](#vet.numbers.isLessThan) \n**Returns**: function - - a validator function \n**Params**\n\n- bound number - the boundary value to check against\n\n\n* * *\n\n\n\n##### isLessThan.inclusive ⇒ function\n**Kind**: static property of [isLessThan](#vet.numbers.isLessThan) \n**Returns**: function - - a validator function \n**Params**\n\n- bound number - the boundary value to check against\n\n\n* * *\n\n\n\n#### numbers.isNegative(val) ⇒\nChecks to see if a value is a negative number\n\n**Kind**: static method of [numbers](#vet.numbers) \n**Returns**: true if the value is a negative number \n**Params**\n\n- val - the value to check\n\n\n* * *\n\n\n\n#### numbers.isNonZero(val) ⇒\nChecks to see if a value is a nonzero number\n\n**Kind**: static method of [numbers](#vet.numbers) \n**Returns**: true if the value is a nonzero number \n**Params**\n\n- val - the value to check\n\n\n* * *\n\n\n\n#### numbers.isNumber(val) ⇒\nChecks to see if a value is a number\n\n**Kind**: static method of [numbers](#vet.numbers) \n**Returns**: true if the value is a number \n**Params**\n\n- val - the value to check\n\n\n* * *\n\n\n\n#### numbers.isPositive(val) ⇒\nChecks to see if a value is a positive number\n\n**Kind**: static method of [numbers](#vet.numbers) \n**Returns**: true if the value is a positive number \n**Params**\n\n- val - the value to check\n\n\n* * *\n\n\n\n#### numbers.isZero(val) ⇒\nChecks to see if a value is zero\n\n**Kind**: static method of [numbers](#vet.numbers) \n**Returns**: true if the value is zero \n**Params**\n\n- val - the value to check\n\n\n* * *\n\n\n\n### vet.objects : object\n**Kind**: static namespace of [vet](#vet) \n\n* [.objects](#vet.objects) : object\n * [.isInstanceOf(con)](#vet.objects.isInstanceOf) ⇒\n * [.isObject(val)](#vet.objects.isObject) ⇒\n * [.isObjectOf(validator)](#vet.objects.isObjectOf) ⇒\n * [.isShape(schema)](#vet.objects.isShape) ⇒\n * [.isShape.exact(schema)](#vet.objects.isShape.isShape.exact) ⇒\n * [.isShape.partial(schema)](#vet.objects.isShape.isShape.partial) ⇒\n\n\n* * *\n\n\n\n#### objects.isInstanceOf(con) ⇒\nChecks to see if a value is an object and inherits a prototype from a constructor function\n\n**Kind**: static method of [objects](#vet.objects) \n**Returns**: a validator to check if a value inherits that prototype \n**Params**\n\n- con - the constructor function to check against\n\n\n* * *\n\n\n\n#### objects.isObject(val) ⇒\nChecks to see if a value is an object\n\n**Kind**: static method of [objects](#vet.objects) \n**Returns**: true if the value is an object \n**Params**\n\n- val - the value to check\n\n\n* * *\n\n\n\n#### objects.isObjectOf(validator) ⇒\nBuilds an object validator that checks the properties of the object\nNOTE: This only checks enumerable properties\n\n**Kind**: static method of [objects](#vet.objects) \n**Returns**: a function that returns true if the value is an object, and all of the object properties pass the validator \n**Params**\n\n- validator - the validator function run against the array children\n\n\n* * *\n\n\n\n#### objects.isShape(schema) ⇒\nBuilds a function to check an object against a schema object\n\nA schema object consists of an object with child object, functions, and values\n\nThe schema matching process is as follows:\n\n1) For each child in the schema object, match it against the corresponding child in the value to be checked\n\n2) If the schema child is a function, treat it as a validator function\n\n3) If the schema child is an object, recursively call the schema matching\n\n4) If the schema child is anything else, check for strict equality\n\n**Kind**: static method of [objects](#vet.objects) \n**Returns**: a validator function that takes in a value val, and returns true if val matches the object schema \n**Params**\n\n- schema - the object schema to check\n\n**Example** \n```javascript\nlet isString from 'vet/strings/isString');\nlet isNumber from 'vet/numbers/isNumber');\nlet isBoolean from 'vet/booleans/isBoolean');\nlet isShape from 'vet/objects/isShape');\n\nlet isPerson = isShape({\n name: isString,\n age: isNumber,\n alive: isBoolean,\n});\n\n// returns false\nisPerson({});\n\n// returns false, no 'alive' flag\nisPerson({ name: 'John Doe', age: 12 });\n\n// returns true\nisPerson({ name: 'John Doe', age: 12, alive: true });\n```\n\n* [.isShape(schema)](#vet.objects.isShape) ⇒\n * [.isShape.exact(schema)](#vet.objects.isShape.isShape.exact) ⇒\n * [.isShape.partial(schema)](#vet.objects.isShape.isShape.partial) ⇒\n\n\n* * *\n\n\n\n##### isShape.isShape.exact(schema) ⇒\nBuilds a function to check an object against a schema object\n\nThis function works similarly to `vet/objects/isShape`,\nbut it also checks to make sure every value in the object to check\nhas a corresponding validator in the schema\n\n**Kind**: static method of [isShape](#vet.objects.isShape) \n**Returns**: a validator function that takes in a value val, and returns true if val matches the object schema exactly \n**Params**\n\n- schema - the object schema to check\n\n**Example** \n```javascript\nlet isString from 'vet/strings/isString');\nlet isNumber from 'vet/numbers/isNumber');\nlet isBoolean from 'vet/booleans/isBoolean');\nlet isShape from 'vet/objects/isShape');\n\nlet isPerson = isShape.exact({\n name: isString,\n age: isNumber,\n alive: isBoolean,\n});\n\n// returns false\nisPerson({});\n\n// returns false, no 'alive' flag\nisPerson({ name: 'John Doe', age: 12 });\n\n// returns false, extra property 'gender'\nisPerson({ name: 'John Doe', age: 12, alive: true, gender: 'm' });\n\n// returns true\nisPerson({ name: 'John Doe', age: 12, alive: true });\n```\n\n* * *\n\n\n\n##### isShape.isShape.partial(schema) ⇒\nBuilds a function to check an object against a schema object\n\nThis function works similarly to `vet/objects/isShape`,\nbut it only checks if the value is a \"partial match\" to the schema, i.e. properties can be undefined\n\n**Kind**: static method of [isShape](#vet.objects.isShape) \n**Returns**: a validator function that takes in a value val, and returns true if val matches the object schema exactly \n**Params**\n\n- schema - the object schema to check\n\n**Example** \n```javascript\nlet isString from 'vet/strings/isString');\nlet isNumber from 'vet/numbers/isNumber');\nlet isBoolean from 'vet/booleans/isBoolean');\nlet isShape from 'vet/objects/isShape');\n\nlet isPerson = isShape.pattial({\n name: isString,\n age: isNumber,\n contact: {\n email: isString,\n phone: isString,\n },\n});\n\n// returns true\nisPerson({});\n\n// returns true\nisPerson({ name: 'John Doe', age: 12 });\n\n// returns true, empty contact still passes\nisPerson({ name: 'John Doe', age: 12, contact: { } });\n\n// returns true, partial contact still passes\nisPerson({ name: 'John Doe', age: 12, contact: { phone: '00000000' } });\n\n// returns false, age is not a number\nisPerson({ name: 'John Doe', age: '12' });\n```\n\n* * *\n\n\n\n### vet.strings : object\n**Kind**: static namespace of [vet](#vet) \n\n* [.strings](#vet.strings) : object\n * [.isEmpty(val)](#vet.strings.isEmpty) ⇒\n * [.isLength(len)](#vet.strings.isLength) ⇒\n * [.isNotEmpty(val)](#vet.strings.isNotEmpty) ⇒\n * [.isProbablyBase64(val)](#vet.strings.isProbablyBase64) ⇒\n * [.isProbablyDataURL(val)](#vet.strings.isProbablyDataURL) ⇒\n * [.isProbablyEmail(val)](#vet.strings.isProbablyEmail) ⇒\n * [.isProbablyURL(val)](#vet.strings.isProbablyURL) ⇒\n * [.isString(val)](#vet.strings.isString) ⇒\n * [.matches(regex)](#vet.strings.matches) ⇒\n\n\n* * *\n\n\n\n#### strings.isEmpty(val) ⇒\nChecks to see if a value is an empty string\n\n**Kind**: static method of [strings](#vet.strings) \n**Returns**: true if val is an empty string \n**Params**\n\n- val - the value to check\n\n\n* * *\n\n\n\n#### strings.isLength(len) ⇒\nBuilds a function to check if a value is a string of length len\n\n**Kind**: static method of [strings](#vet.strings) \n**Returns**: a function that takes in a value val, and returns true if val is a string of length len \n**Params**\n\n- len - the desired length of string\n\n\n* * *\n\n\n\n#### strings.isNotEmpty(val) ⇒\nChecks to see if a value is a non-empty string\n\n**Kind**: static method of [strings](#vet.strings) \n**Returns**: true if val is a non-empty string \n**Params**\n\n- val - the value to check\n\n\n* * *\n\n\n\n#### strings.isProbablyBase64(val) ⇒\nChecks to see if a value is probably a valid base64 string\n\n**Kind**: static method of [strings](#vet.strings) \n**Returns**: true if val is probably a valid base64 string \n**Params**\n\n- val - the value to check\n\n\n* * *\n\n\n\n#### strings.isProbablyDataURL(val) ⇒\nChecks to see if a value is probably a valid data URL\n\n**Kind**: static method of [strings](#vet.strings) \n**Returns**: true if val is probably a valid data URL \n**Params**\n\n- val - the value to check\n\n\n* * *\n\n\n\n#### strings.isProbablyEmail(val) ⇒\nChecks to see if a value is probably a valid email\n\n**Kind**: static method of [strings](#vet.strings) \n**Returns**: true if val is probably a valid email \n**Params**\n\n- val - the value to check\n\n\n* * *\n\n\n\n#### strings.isProbablyURL(val) ⇒\nChecks to see if a value is probably a valid URL\n\n**Kind**: static method of [strings](#vet.strings) \n**Returns**: true if val is probably a valid URL \n**Params**\n\n- val - the value to check\n\n\n* * *\n\n\n\n#### strings.isString(val) ⇒\nChecks to see if a value is a string\n\n**Kind**: static method of [strings](#vet.strings) \n**Returns**: true if val is a string \n**Params**\n\n- val - the value to check\n\n\n* * *\n\n\n\n#### strings.matches(regex) ⇒\nBuilds a function that checks to see if a value matches a regular expression\n\n**Kind**: static method of [strings](#vet.strings) \n**Returns**: a function that takes in a value val, and returns true if it is a string that matches regex \n**Params**\n\n- regex - the regular expression to check against\n\n\n* * *\n\n\n\n### vet.utils : object\n**Kind**: static namespace of [vet](#vet) \n\n* [.utils](#vet.utils) : object\n * [.assertReact](#vet.utils.assertReact) ⇒\n * [.assert(validator, message)](#vet.utils.assert) ⇒\n\n\n* * *\n\n\n\n#### utils.assertReact ⇒\nA utility function for building a react-compatible assertion from a Vet validator\n\nThis is useful for some libraries (like React) that expect\nassertion-style validation.\n\n**Kind**: static property of [utils](#vet.utils) \n**Returns**: a function that returns null if the arguments pass validation, or throws an error if they do not \n**Params**\n\n- validator - the validator to wrap\n- message - an optional message string to pass into the error\n\n\n* * *\n\n\n\n#### utils.assert(validator, message) ⇒\nWraps a validator, and throws an error if it returns false.\n\nThis is useful for some code that expects assertion-style validation.\n\n**Kind**: static method of [utils](#vet.utils) \n**Returns**: a function that returns null if the arguments pass validation, or throws an error if they do not \n**Params**\n\n- validator - the validator to wrap\n- message - an optional message string to pass into the error\n\n\n* * *\n\n\n\n### vet.equals(eq) ⇒\nBuilds an curried equal function\n\n**Kind**: static method of [vet](#vet) \n**Returns**: a function that takes in one parameter val, and returns true if val === eq \n**Params**\n\n- eq - value to check equality against\n\n**Example** \n```javascript\nlet equals from 'vet/equals');\n\nlet is3 = equals(3);\n\nis3(null); // returns false\nis3({}); // returns false\n\nis3(3); // returns true\n```\n\n* * *\n\n\n\n### vet.exists(val) ⇒\nAlias for `vet/isNotNullOrUndefined`\n\n**Kind**: static method of [vet](#vet) \n**Returns**: true if val is not null or undefined \n**Params**\n\n- val - value to check\n\n**Example** \n```javascript\n\nlet exists from 'vet/exists');\n\nexists(null); // returns false\nexists(undefined); // returns false\nexists({}); // returns true\n\n```\n\n* * *\n\n\n\n### vet.isAllOf(...eq) ⇒\nConstructs a function that checks equality against any number of arguments\n\n**Kind**: static method of [vet](#vet) \n**Returns**: a function that takes in a parameter val, and returns true if val is equal to any of the options in ...eq \n**Params**\n\n- ...eq \\* - values to check equality against\n\n**Example** \n```javascript\nlet isAllOf from 'vet/isAllOf');\nlet isNumber from 'vet/numbers/isNumber');\nlet isPositive from 'vet/numbers/isPositive');\n\nlet check = isAllOf(isNumber, isPositive);\n\ncheck(-1); // returns false\n\ncheck(1); // returns true\n```\n\n* * *\n\n\n\n### vet.isAny(val) ⇒\nA default validator, that always returns true.\nThis can be useful to spec out parameters that you don't wish to validate,\nbut need to document for future work.\n\n**Kind**: static method of [vet](#vet) \n**Returns**: true \n**Params**\n\n- val - a value to check\n\n**Example** \n```javascript\n\nimport isAny from 'vet/isAny';\n\nisAny(null); // returns true\nisAny(undefined); // returns true\nisAny({}); // returns true\n\n```\n\n* * *\n\n\n\n### vet.isNoneOf(...eq) ⇒\nConstructs a function that checks equality against any number of arguments\n\n**Kind**: static method of [vet](#vet) \n**Returns**: a function that takes in a parameter val, and returns true if val is NOT equal to any of the options in ...eq \n**Params**\n\n- ...eq \\* - values to check equality against\n\n**Example** \n```javascript\nlet isNoneOf from 'vet/isNoneOf');\n\nlet check = isNoneOf(1, 2, 3);\n\ncheck(1); // returns false\n\ncheck(4); // returns true\n```\n\n* * *\n\n\n\n### vet.isNot(validator) ⇒\na function that inverts the result of a validator\n\n**Kind**: static method of [vet](#vet) \n**Returns**: a wrapper function that inverts the result of a validator \n**Params**\n\n- validator function - validator to invert\n\n**Example** \n```javascript\nlet isNot from 'vet/isNot');\nlet isNumber from 'vet/numbers/isNumber');\n\nlet check = isNot(isNumber);\n\ncheck(1); // returns false\n\ncheck(null); // returns true\n```\n\n* * *\n\n\n\n### vet.isNotNull(val) ⇒\nA function to check for nulls\n\n**Kind**: static method of [vet](#vet) \n**Returns**: true if val is strictly not equal to null \n**Params**\n\n- val - a value to check against null\n\n**Example** \n```javascript\n\nlet isNotNull from 'vet/isNotNull');\n\nisNotNull(null); // returns false\n\nisNotNull(undefined); // returns true\nisNotNull({}); // returns true\n\n```\n\n* * *\n\n\n\n### vet.isNotNullOrUndefined(val) ⇒\nA function to check for null or undefined\n\n**Kind**: static method of [vet](#vet) \n**Returns**: true if val is loosely not null (strictly not null or undefined) \n**Params**\n\n- val - a value to check against null and undefined\n\n**Example** \n```javascript\nlet isNotNullOrUndefined from 'vet/isNotNullOrUndefined');\n\nisNotNullOrUndefined(null); // returns false\nisNotNullOrUndefined(undefined); // returns false\n\nisNotNullOrUndefined({}); // returns true\n```\n\n* * *\n\n\n\n### vet.isNotUndefined(val) ⇒\nA function to check for undefined\n\n**Kind**: static method of [vet](#vet) \n**Returns**: true if val is strictly not undefined \n**Params**\n\n- val - a value to check\n\n**Example** \n```javascript\nlet isNotUndefined from 'vet/isNotUndefined');\n\nisNotUndefined(undefined); // returns false\n\nisNotUndefined(null); // returns true\nisNotUndefined({}); // returns true\n```\n\n* * *\n\n\n\n### vet.isNull(val) ⇒\nA function to check for null\n\n**Kind**: static method of [vet](#vet) \n**Returns**: true if val is strictly null \n**Params**\n\n- val - a value to check\n\n**Example** \n```javascript\nlet isNull from 'vet/isNull');\n\nisNull(undefined); // returns false\nisNull({}); // returns false\n\nisNull(null); // returns true\n```\n\n* * *\n\n\n\n### vet.isNullOrUndefined(val) ⇒\nA function to check for null or undefined\n\n**Kind**: static method of [vet](#vet) \n**Returns**: true if val is loosely null (strictly null or undefined) \n**Params**\n\n- val - a value to check\n\n**Example** \n```javascript\nlet isNullOrUndefined from 'vet/isNullOrUndefined');\n\nisNullOrUndefined({}); // returns false\n\nisNullOrUndefined(undefined); // returns true\nisNullOrUndefined(null); // returns true\n```\n\n* * *\n\n\n\n### vet.isOneOf(...eq) ⇒\nConstructs a function that checks equality against any number of arguments\n\n**Kind**: static method of [vet](#vet) \n**Returns**: a function that takes in a parameter val, and returns true if val is equal to any of the options in ...eq \n**Params**\n\n- ...eq \\* - values to check equality against\n\n**Example** \n```javascript\nlet isOneOf from 'vet/isOneOf');\n\nlet check = isOneOf(1, 2, 3);\n\ncheck(4); // returns false\n\ncheck(1); // returns true\n```\n\n* * *\n\n\n\n### vet.isUndefined(val) ⇒\nA function to check for undefined\n\n**Kind**: static method of [vet](#vet) \n**Returns**: true if val is strictly undefined \n**Params**\n\n- val - a value to check\n\n**Example** \n```javascript\nlet isUndefined from 'vet/isUndefined');\n\nisUndefined({}); // returns false\nisUndefined(null); // returns false\n\nisUndefined(undefined); // returns true\n```\n\n* * *\n\n\n\n### vet.nullable(validator) ⇒\nA function builder to check for a value or null\n\n**Kind**: static method of [vet](#vet) \n**Returns**: a function that takes in a value, and returns true if the value is null, or the wrapped validator returns true \n**Params**\n\n- validator - a validator function\n\n**Example** \n```javascript\nlet nullable from 'vet/nullable');\nlet isNumber from 'vet/numbers/isNumber');\n\nlet isMaybeNumber = nullable(isNumber);\n\nisMaybeNumber(undefined); // returns false\nisMaybeNumber(\"1\"); // returns false\n\nisMaybeNumber(1); // returns true\nisMaybeNumber(null); // returns true\n```\n\n* * *\n\n\n\n### vet.optional(validator) ⇒\nA function builder to optionally check a value\n\n**Kind**: static method of [vet](#vet) \n**Returns**: a function that takes in a value, and returns true if the value does not exist, or the validator returns true \n**Params**\n\n- validator - a validator function\n\n**Example** \n```javascript\nlet optional from 'vet/optional');\nlet isNumber from 'vet/numbers/isNumber');\n\nlet isMaybeNumber = optional(isNumber);\n\nisMaybeNumber(null); // returns false\nisMaybeNumber(\"1\"); // returns false\n\nisMaybeNumber(1); // returns true\nisMaybeNumber(undefined); // returns true\n```\n\n* * *\n\n\n\n## exactType()\nTrigger a compiler error when a value is _not_ an exact type.\n\n**Kind**: global function \n\n* * *\n\n\n\n## exactType()\nTrigger a compiler error when a value is _not_ an exact type.\n\n**Kind**: global function \n\n* * *\n\n ","readmeFilename":"README.md"}