Skip to content

Latest commit

 

History

History
551 lines (405 loc) · 15.1 KB

API.md

File metadata and controls

551 lines (405 loc) · 15.1 KB
Raw

API

class: Validator

static Validator.valid

  • returns: <boolean> Defaults to true.

static Validator.errors

static Validator.Error

static Validator.ValidationError

static Validator.has(object, path)

  • object <Object>
  • path <string | Array<string>> Must have format: 'object.property.key.path[0]'. If undefined, null, '' or [] will not be validated.
  • returns: <boolean>

static Validator.hasIn(object, path)

  • object <Object>
  • path <string | Array<string>> Must have format: 'object.property.key.path[0]'. If undefined, null, '' or [] will not be validated.
  • returns: <boolean>

static Validator.exists(value[, path])

  • value <any> If undefined or null will be return false.
  • returns: <boolean>

static Validator.existsIn(object, path)

  • value <any> If undefined or null will be return false.
  • path <string | Array<string>> Must have format: 'object.property.key.path[0]'. If undefined, null, '' or [] will not be validated.
  • returns: <boolean>

static Validator.equals(value, other)

static Validator.startsWith(string, searchValue[, position])

static Validator.endsWith(string, searchValue[, length])

static Validator.includes(input, searchValue[, fromIndex])

static Validator.isType(value, type)

static Validator.isTag(value, tag)

static Validator.isInstance(value, constructor)

static Validator.isUndefined(value)

static Validator.isPrimitive(value)

static Validator.isNull(value)

static Validator.isNil(value)

static Validator.isObject(value)

static Validator.isObjectLike(value)

static Validator.isPlainObject(value)

static Validator.isFunction(value)

static Validator.isAsyncFunction(value)

static Validator.isBoolean(value)

static Validator.isNumber(value)

static Validator.isString(value)

static Validator.isSymbol(value)

static Validator.isArray(value)

static Validator.isBuffer(value)

static Validator.isTypedArray(value)

static Validator.isRegExp(value)

static Validator.isSet(value)

static Validator.isMap(value)

static Validator.isWeakSet(value)

static Validator.isWeakMap(value)

static Validator.isPromise(value)

static Validator.isDate(value)

static Validator.isError(value)

static Validator.isFinite(value)

static Validator.isFloat(value)

static Validator.isInteger(value)

static Validator.isSafeInteger()

static Validator.isNaN(value)

static Validator.isInfinity(value)

static Validator.isDecimal(value)

static Validator.isPositive(value)

static Validator.isNegative(value)

static Validator.isNonNegative(value)

static Validator.isNonPositive(value)

static Validator.isNatural(value)

static Validator.isWhole(value)

static Validator.isEmpty(value)

static Validator.isKey(value)

static Validator.isIndex(value[, length])

static Validator.isJSON(value)

static Validator.isASCII(value)

static Validator.isBase64(value)

static Validator.isIPv4(value)

static Validator.isIPv6(value)

static Validator.isURL(value)

static Validator.isUUID(value)

static Validator.isEmail(value)

static Validator.isPhoneNumber(value)

static Validator.from(value[, valid])

init new Validator(value[, valid])

validator.valid

  • returns: <boolean> Defaults to true.

validator.value

  • returns: <any> Defaults to undefined.

get validator.isValid

Equivalent to <validator.valid>

validator.setValue(value)

validator.setValid(boolean)

validator.is(callback[, ...args])

  • callback <Function(any, ...<any>>)>
    • value <any>
    • ...args <...any>
  • ...args <...any> The arguments will be passed to the callback function.
  • returns: <this>

validator.validate(callback)

validator.has(path)

  • path <string | Array<string>> Must have format: 'object.property.key.path[0]'. If undefined, null, '' or [] will not be validated.
  • returns: <this>

validator.hasIn(path)

  • path <string | Array<string>> Must have format: 'object.property.key.path[0]'. If undefined, null, '' or [] will not be validated.
  • returns: <this>

validator.exists()

validator.existsIn(path)

  • path <string | Array<string>> Must have format: 'object.property.key.path[0]'. If undefined, null, '' or [] will not be used.
  • returns: <this>

validator.equals(value)

validator.startsWith(searchValue[, position])

validator.endsWith(searchValue[, length])

validator.includes(searchValue[, fromIndex])

validator.isType(type)

validator.isTag(tag)

  • tag <string> Must have format: [object <Tag>].
  • returns: <this>

validator.isInstance(constructor)

validator.isUndefined()

validator.isPrimitive()

validator.isNull()

validator.isNil()

validator.isObject()

validator.isObjectLike()

validator.isPlainObject()

validator.isFunction()

validator.isAsyncFunction()

validator.isBoolean()

validator.isNumber()

validator.isString()

validator.isSymbol()

validator.isArray()

validator.isBuffer()

validator.isTypedArray()

validator.isRegExp()

validator.isSet()

validator.isMap()

validator.isWeakSet()

validator.isWeakMap()

validator.isPromise()

validator.isDate()

validator.isError()

validator.isFinite()

validator.isFloat()

validator.isInteger()

validator.isSafeInteger()

validator.isNaN()

validator.isInfinity()

validator.isDecimal()

validator.isPositive()

validator.isNegative()

validator.isNonNegative()

validator.isNonPositive()

validator.isNatural()

validator.isWhole()

validator.isEmpty()

validator.isKey()

validator.isIndex()

validator.isJSON()

validator.isASCII()

validator.isBase64()

validator.isIPv4()

validator.isIPv6()

validator.isURL()

validate.isUUID()

validator.isEmail()

validator.isPhoneNumber()

validator.reset()

validator.toString()

validator.valueOf()

validator.toJSON()

validator.clone()

validator[Symbol.toPrimitive](hint)

class: Errors

static Errors.Error

static Errors.ValidationError

class: ValidatorError

static ValidatorError.name

  • returns: <string> Defaults to 'ValidatorError'.

class: ValidationError

static ValidationError.name

  • returns: <string> Defaults to 'ValidationError'.

static ValidationError.code

  • returns: <string> Defaults to 'invalid-value'.