validate.md

validate

Registers the contexts and methods of the module validate in microTasks.

• validate
  • ~context
  • ~validate.contains(str, substr) ⇒ boolean
  • ~validate.isArray(value) ⇒ boolean
  • ~validate.isDate(date) ⇒ boolean
  • ~validate.isEmail(value) ⇒ boolean
  • ~validate.isEmpty(value) ⇒ boolean
  • ~validate.isEqual(value, other) ⇒ boolean
  • ~validate.isGreatThan(value, other) ⇒ boolean
  • ~validate.isGreatThanOrEqualTo(value, other) ⇒ boolean
  • ~validate.isLessThan(value, other) ⇒ boolean
  • ~validate.isLessThanOrEqualTo(value, other) ⇒ boolean
  • ~validate.isNotEmpty(value) ⇒ boolean
  • ~validate.isNull(value) ⇒ boolean
  • ~validate.isNumber(value) ⇒ boolean
  • ~validate.isPlainObject(value) ⇒ boolean
  • ~validate.isString(value) ⇒ boolean
  • ~validate.isTrue(value) ⇒ boolean
  • ~validate.isUndefined(value) ⇒ boolean
  • ~validate.every(validator, items) ⇒ boolean
  • ~validate.validator(validator, error, [args]) ⇒ promise

validate~context

Context item list registered in microTasks.

Name	Type	Description
validate.regexEmail	RegExp	Email regular expresion

validate~validate.contains(str, substr) ⇒ boolean

Returns: boolean - Returns if string contains a substring.

Name	Type	Description
str	string	The string to inspect
substr	string	The string to search for

Example

microTasks.taskRun([{ method: 'validate.contains', params: ['abcdef', 'bcd'], resultPath: 'contains' }])
// payload.contains = true

validate~validate.isArray(value) ⇒ boolean

Returns: boolean - Returns if value is an array.

Name	Type	Description
value	string	Value

Example

microTasks.taskRun([{ method: 'validate.isArray', params: [[1, 2, 3]], resultPath: 'is' }])
// payload.is = true

validate~validate.isDate(date) ⇒ boolean

Returns: boolean - Returns if value is a date.

Name	Type	Description
date	date	Date

Example

microTasks.taskRun([{ method: 'validate.isDate', params: new Date(), resultPath: 'isDate' }])
// payload.isDate = true

validate~validate.isEmail(value) ⇒ boolean

Returns: boolean - Returns if value is an email.

Name	Type	Description
value	string	Email value

Example

microTasks.taskRun([{ method: 'validate.isEmail', params: 'info@migueldelmazo.com', resultPath: 'is' }])
// payload.is = true

validate~validate.isEmpty(value) ⇒ boolean

Returns: boolean - Returns if value is empty.

Name	Type	Description
value	*	Value

Example

microTasks.taskRun([{ method: 'validate.isEmpty', params: '', resultPath: 'is' }])
// payload.is = true

validate~validate.isEqual(value, other) ⇒ boolean

Returns: boolean - Returns if value is equal than other.

Name	Type	Description
value	*	Value
other	*	Value

Example

microTasks.taskRun([{ method: 'validate.isEqual', params: [1, 1], resultPath: 'is' }])
// payload.is = true

validate~validate.isGreatThan(value, other) ⇒ boolean

Returns: boolean - Returns if value is great than other.

Name	Type	Description
value	*	Value
other	*	Value

Example

microTasks.taskRun([{ method: 'validate.isGreatThan', params: [2, 1], resultPath: 'is' }])
// payload.is = true

validate~validate.isGreatThanOrEqualTo(value, other) ⇒ boolean

Returns: boolean - Returns if value is great than or equal to other.

Name	Type	Description
value	*	Value
other	*	Value

Example

microTasks.taskRun([{ method: 'validate.isGreatThanOrEqualTo', params: [1, 1], resultPath: 'is' }])
// payload.is = true

validate~validate.isLessThan(value, other) ⇒ boolean

Returns: boolean - Returns if value is less than other.

Name	Type	Description
value	*	Value
other	*	Value

Example

microTasks.taskRun([{ method: 'validate.isLessThan', params: [1, 2], resultPath: 'is' }])
// payload.is = true

validate~validate.isLessThanOrEqualTo(value, other) ⇒ boolean

Returns: boolean - Returns if value is less than or equal to other.

Name	Type	Description
value	*	Value
other	*	Value

Example

microTasks.taskRun([{ method: 'validate.isLessThanOrEqualTo', params: [1, 1], resultPath: 'is' }])
// payload.is = true

validate~validate.isNotEmpty(value) ⇒ boolean

Returns: boolean - Returns if value is not empty.

Name	Type	Description
value	*	Value

Example

microTasks.taskRun([{ method: 'validate.isNotEmpty', params: 'foo', resultPath: 'is' }])
// payload.is = true

validate~validate.isNull(value) ⇒ boolean

Returns: boolean - Returns if value is NULL.

Name	Type	Description
value	*	Value

Example

microTasks.taskRun([{ method: 'validate.isNull', params: [null], resultPath: 'is' }])
// payload.is = true

validate~validate.isNumber(value) ⇒ boolean

Returns: boolean - Returns if value is a number.

Name	Type	Description
value	*	Value

Example

microTasks.taskRun([{ method: 'validate.isNumber', params: 1, resultPath: 'is' }])
// payload.is = true

validate~validate.isPlainObject(value) ⇒ boolean

Returns: boolean - Returns if value is a plain object.

Name	Type	Description
value	*	Value

Example

microTasks.taskRun([{ method: 'validate.isPlainObject', params: { one: 1 }, resultPath: 'is' }])
// payload.is = true

validate~validate.isString(value) ⇒ boolean

Returns: boolean - Returns if value is a string.

Name	Type	Description
value	*	Value

Example

microTasks.taskRun([{ method: 'validate.isString', params: 'foo', resultPath: 'is' }])
// payload.is = true

validate~validate.isTrue(value) ⇒ boolean

Returns: boolean - Returns if value is true.

Name	Type	Description
value	*	Value

Example

microTasks.taskRun([{ method: 'validate.isTrue', params: true, resultPath: 'is' }])
// payload.is = true

validate~validate.isUndefined(value) ⇒ boolean

Returns: boolean - Returns if value is UNDEFINED.

Name	Type	Description
value	*	Value

Example

microTasks.taskRun([{ method: 'validate.isUndefined', params: undefined, resultPath: 'is' }])
// payload.is = true

validate~validate.every(validator, items) ⇒ boolean

Returns: boolean - Checks if validator returns truthy for all items of collection.

Name	Type	Description
validator	string	Name of validator method
items	items	Items to validate

Example

microTasks.taskRun([{ method: 'validate.every', params: ['validate.isTrue', true, true, true], resultPath: 'is' }])
// payload.is = true

validate~validate.validator(validator, error, [args]) ⇒ promise

Returns: promise - Returns a rejected promise if validator method returns false or a rejected promise.

Name	Type	Description
validator	string	Validator method name
error	*	Error with which the promise is rejected
[args]	*	Other arguments

Example

microTasks.taskRun([{
  method: 'validate.validator',
  params: ['validate.isNumber', 'It is not a number', 1]
}])
microTasks.taskRun([{
  method: 'validate.validator',
  params: ['validate.isNumber', 'It is not a number', '1']
}])