api documentation for koa-validate (v1.0.7)

A koa params validate middleware.

table of contents

  1. module koa-validate
    1. function koa-validate (app)
    2. function koa-validate.FileValidator (context, key, value, exists, params, deleteOnCheckFailed)
    3. function koa-validate.Validator (context, key, value, exists, params , goOn)
    4. object koa-validate.FileValidator.prototype
    5. object koa-validate.Validator.prototype
  2. module koa-validate.FileValidator
    1. function koa-validate.FileValidator (context, key, value, exists, params, deleteOnCheckFailed)
    2. function koa-validate.FileValidator.super_ (context, key, value, exists, params , goOn)
  3. module koa-validate.FileValidator.prototype
    1. function koa-validate.FileValidator.prototype.contentTypeMatch (reg, tip)
    2. function koa-validate.FileValidator.prototype.copy (dst, afterCopy)
    3. function koa-validate.FileValidator.prototype.delete ()
    4. function koa-validate.FileValidator.prototype.fileNameMatch (reg, tip)
    5. function koa-validate.FileValidator.prototype.isImageContentType (tip)
    6. function koa-validate.FileValidator.prototype.move (dst, afterMove)
    7. function koa-validate.FileValidator.prototype.notEmpty (tip)
    8. function koa-validate.FileValidator.prototype.size (min, max, tip)
    9. function koa-validate.FileValidator.prototype.suffixIn (arr, tip)
  4. module koa-validate.Validator
    1. function koa-validate.Validator (context, key, value, exists, params , goOn)
  5. module koa-validate.Validator.prototype
    1. function koa-validate.Validator.prototype.addError (tip)
    2. function koa-validate.Validator.prototype.blacklist (s)
    3. function koa-validate.Validator.prototype.byteLength (min, max, charset, tip)
    4. function koa-validate.Validator.prototype.check (fn , tip, scope)
    5. function koa-validate.Validator.prototype.clone (key , value)
    6. function koa-validate.Validator.prototype.contains (s, tip)
    7. function koa-validate.Validator.prototype.decodeBase64 (inBuffer , tip)
    8. function koa-validate.Validator.prototype.decodeURI (tip)
    9. function koa-validate.Validator.prototype.decodeURIComponent (tip)
    10. function koa-validate.Validator.prototype.default (d)
    11. function koa-validate.Validator.prototype.empty ()
    12. function koa-validate.Validator.prototype.encodeBase64 ()
    13. function koa-validate.Validator.prototype.encodeURI ()
    14. function koa-validate.Validator.prototype.encodeURIComponent ()
    15. function koa-validate.Validator.prototype.ensure (assertion, tip, shouldBail)
    16. function koa-validate.Validator.prototype.ensureNot (assertion, tip, shouldBail)
    17. function koa-validate.Validator.prototype.eq (l, tip)
    18. function koa-validate.Validator.prototype.escape ()
    19. function koa-validate.Validator.prototype.exist (tip)
    20. function koa-validate.Validator.prototype.filter (cb, scope)
    21. function koa-validate.Validator.prototype.first (index)
    22. function koa-validate.Validator.prototype.ge (l, tip)
    23. function koa-validate.Validator.prototype.get (index)
    24. function koa-validate.Validator.prototype.gt (l, tip)
    25. function koa-validate.Validator.prototype.hasError ()
    26. function koa-validate.Validator.prototype.hash (alg , enc)
    27. function koa-validate.Validator.prototype.in (arr, tip)
    28. function koa-validate.Validator.prototype.isAfter (d, tip)
    29. function koa-validate.Validator.prototype.isAlpha (tip, locale)
    30. function koa-validate.Validator.prototype.isAlphanumeric (tip, locale)
    31. function koa-validate.Validator.prototype.isAscii (tip)
    32. function koa-validate.Validator.prototype.isBase64 (tip)
    33. function koa-validate.Validator.prototype.isBefore (d, tip)
    34. function koa-validate.Validator.prototype.isByteLength (min, max, charset, tip)
    35. function koa-validate.Validator.prototype.isCreditCard (tip)
    36. function koa-validate.Validator.prototype.isCurrency (tip, options)
    37. function koa-validate.Validator.prototype.isDataURI (tip)
    38. function koa-validate.Validator.prototype.isDate (tip)
    39. function koa-validate.Validator.prototype.isDivisibleBy (n, tip)
    40. function koa-validate.Validator.prototype.isEmail (tip, options)
    41. function koa-validate.Validator.prototype.isFQDN (tip, options)
    42. function koa-validate.Validator.prototype.isFloat (tip, options)
    43. function koa-validate.Validator.prototype.isFullWidth (tip)
    44. function koa-validate.Validator.prototype.isHalfWidth (tip)
    45. function koa-validate.Validator.prototype.isHexColor (tip)
    46. function koa-validate.Validator.prototype.isHexadecimal (tip)
    47. function koa-validate.Validator.prototype.isISBN (tip, version)
    48. function koa-validate.Validator.prototype.isISIN (tip)
    49. function koa-validate.Validator.prototype.isISO8601 (tip)
    50. function koa-validate.Validator.prototype.isIn (arr, tip)
    51. function koa-validate.Validator.prototype.isInt (tip, options)
    52. function koa-validate.Validator.prototype.isIp (tip, version)
    53. function koa-validate.Validator.prototype.isJSON (tip)
    54. function koa-validate.Validator.prototype.isLength (min, max, tip)
    55. function koa-validate.Validator.prototype.isLowercase (tip)
    56. function koa-validate.Validator.prototype.isMACAddress (tip)
    57. function koa-validate.Validator.prototype.isMobilePhone (tip, locale)
    58. function koa-validate.Validator.prototype.isMultibyte (tip)
    59. function koa-validate.Validator.prototype.isNull (tip)
    60. function koa-validate.Validator.prototype.isNumeric (tip)
    61. function koa-validate.Validator.prototype.isSurrogatePair (tip)
    62. function koa-validate.Validator.prototype.isTime (tip)
    63. function koa-validate.Validator.prototype.isUUID (tip, ver)
    64. function koa-validate.Validator.prototype.isUppercase (tip)
    65. function koa-validate.Validator.prototype.isUrl (tip, options)
    66. function koa-validate.Validator.prototype.isVariableWidth (tip)
    67. function koa-validate.Validator.prototype.le (l, tip)
    68. function koa-validate.Validator.prototype.len (min, max, tip)
    69. function koa-validate.Validator.prototype.lt (l, tip)
    70. function koa-validate.Validator.prototype.ltrim (c)
    71. function koa-validate.Validator.prototype.match (reg, tip)
    72. function koa-validate.Validator.prototype.md5 ()
    73. function koa-validate.Validator.prototype.neq (l, tip)
    74. function koa-validate.Validator.prototype.notBlank (tip)
    75. function koa-validate.Validator.prototype.notContains (s, tip)
    76. function koa-validate.Validator.prototype.notEmpty (tip)
    77. function koa-validate.Validator.prototype.notMatch (reg, tip)
    78. function koa-validate.Validator.prototype.optional ()
    79. function koa-validate.Validator.prototype.replace (a, b)
    80. function koa-validate.Validator.prototype.rtrim (c)
    81. function koa-validate.Validator.prototype.sha1 ()
    82. function koa-validate.Validator.prototype.stripLow (nl)
    83. function koa-validate.Validator.prototype.toBoolean ()
    84. function koa-validate.Validator.prototype.toDate ()
    85. function koa-validate.Validator.prototype.toFloat (tip)
    86. function koa-validate.Validator.prototype.toInt (tip, radix, options)
    87. function koa-validate.Validator.prototype.toJson (tip)
    88. function koa-validate.Validator.prototype.toLow ()
    89. function koa-validate.Validator.prototype.toLowercase ()
    90. function koa-validate.Validator.prototype.toUp ()
    91. function koa-validate.Validator.prototype.toUppercase ()
    92. function koa-validate.Validator.prototype.trim (c)
    93. function koa-validate.Validator.prototype.type (t, tip)
    94. function koa-validate.Validator.prototype.whitelist (s)

module koa-validate

function koa-validate (app)

function koa-validate.FileValidator (context, key, value, exists, params, deleteOnCheckFailed)

function koa-validate.Validator (context, key, value, exists, params , goOn)

module koa-validate.FileValidator

function koa-validate.FileValidator (context, key, value, exists, params, deleteOnCheckFailed)

function koa-validate.FileValidator.super_ (context, key, value, exists, params , goOn)

module koa-validate.FileValidator.prototype

function koa-validate.FileValidator.prototype.contentTypeMatch (reg, tip)

function koa-validate.FileValidator.prototype.copy (dst, afterCopy)

function koa-validate.FileValidator.prototype.delete ()

function koa-validate.FileValidator.prototype.fileNameMatch (reg, tip)

function koa-validate.FileValidator.prototype.isImageContentType (tip)

function koa-validate.FileValidator.prototype.move (dst, afterMove)

function koa-validate.FileValidator.prototype.notEmpty (tip)

function koa-validate.FileValidator.prototype.size (min, max, tip)

function koa-validate.FileValidator.prototype.suffixIn (arr, tip)

module koa-validate.Validator

function koa-validate.Validator (context, key, value, exists, params , goOn)

module koa-validate.Validator.prototype

function koa-validate.Validator.prototype.addError (tip)

function koa-validate.Validator.prototype.blacklist (s)

function koa-validate.Validator.prototype.byteLength (min, max, charset, tip)

function koa-validate.Validator.prototype.check (fn , tip, scope)

function koa-validate.Validator.prototype.clone (key , value)

function koa-validate.Validator.prototype.contains (s, tip)

function koa-validate.Validator.prototype.decodeBase64 (inBuffer , tip)

function koa-validate.Validator.prototype.decodeURI (tip)

function koa-validate.Validator.prototype.decodeURIComponent (tip)

function koa-validate.Validator.prototype.default (d)

function koa-validate.Validator.prototype.empty ()

function koa-validate.Validator.prototype.encodeBase64 ()

function koa-validate.Validator.prototype.encodeURI ()

function koa-validate.Validator.prototype.encodeURIComponent ()

function koa-validate.Validator.prototype.ensure (assertion, tip, shouldBail)

function koa-validate.Validator.prototype.ensureNot (assertion, tip, shouldBail)

function koa-validate.Validator.prototype.eq (l, tip)

function koa-validate.Validator.prototype.escape ()

function koa-validate.Validator.prototype.exist (tip)

function koa-validate.Validator.prototype.filter (cb, scope)

function koa-validate.Validator.prototype.first (index)

function koa-validate.Validator.prototype.ge (l, tip)

function koa-validate.Validator.prototype.get (index)

function koa-validate.Validator.prototype.gt (l, tip)

function koa-validate.Validator.prototype.hasError ()

function koa-validate.Validator.prototype.hash (alg , enc)

function koa-validate.Validator.prototype.in (arr, tip)

function koa-validate.Validator.prototype.isAfter (d, tip)

function koa-validate.Validator.prototype.isAlpha (tip, locale)

function koa-validate.Validator.prototype.isAlphanumeric (tip, locale)

function koa-validate.Validator.prototype.isAscii (tip)

function koa-validate.Validator.prototype.isBase64 (tip)

function koa-validate.Validator.prototype.isBefore (d, tip)

function koa-validate.Validator.prototype.isByteLength (min, max, charset, tip)

function koa-validate.Validator.prototype.isCreditCard (tip)

function koa-validate.Validator.prototype.isCurrency (tip, options)

function koa-validate.Validator.prototype.isDataURI (tip)

function koa-validate.Validator.prototype.isDate (tip)

function koa-validate.Validator.prototype.isDivisibleBy (n, tip)

function koa-validate.Validator.prototype.isEmail (tip, options)

function koa-validate.Validator.prototype.isFQDN (tip, options)

function koa-validate.Validator.prototype.isFloat (tip, options)

function koa-validate.Validator.prototype.isFullWidth (tip)

function koa-validate.Validator.prototype.isHalfWidth (tip)

function koa-validate.Validator.prototype.isHexColor (tip)

function koa-validate.Validator.prototype.isHexadecimal (tip)

function koa-validate.Validator.prototype.isISBN (tip, version)

function koa-validate.Validator.prototype.isISIN (tip)

function koa-validate.Validator.prototype.isISO8601 (tip)

function koa-validate.Validator.prototype.isIn (arr, tip)

function koa-validate.Validator.prototype.isInt (tip, options)

function koa-validate.Validator.prototype.isIp (tip, version)

function koa-validate.Validator.prototype.isJSON (tip)

function koa-validate.Validator.prototype.isLength (min, max, tip)

function koa-validate.Validator.prototype.isLowercase (tip)

function koa-validate.Validator.prototype.isMACAddress (tip)

function koa-validate.Validator.prototype.isMobilePhone (tip, locale)

function koa-validate.Validator.prototype.isMultibyte (tip)

function koa-validate.Validator.prototype.isNull (tip)

function koa-validate.Validator.prototype.isNumeric (tip)

function koa-validate.Validator.prototype.isSurrogatePair (tip)

function koa-validate.Validator.prototype.isTime (tip)

function koa-validate.Validator.prototype.isUUID (tip, ver)

function koa-validate.Validator.prototype.isUppercase (tip)

function koa-validate.Validator.prototype.isUrl (tip, options)

function koa-validate.Validator.prototype.isVariableWidth (tip)

function koa-validate.Validator.prototype.le (l, tip)

function koa-validate.Validator.prototype.len (min, max, tip)

function koa-validate.Validator.prototype.lt (l, tip)

function koa-validate.Validator.prototype.ltrim (c)

function koa-validate.Validator.prototype.match (reg, tip)

function koa-validate.Validator.prototype.md5 ()

function koa-validate.Validator.prototype.neq (l, tip)

function koa-validate.Validator.prototype.notBlank (tip)

function koa-validate.Validator.prototype.notContains (s, tip)

function koa-validate.Validator.prototype.notEmpty (tip)

function koa-validate.Validator.prototype.notMatch (reg, tip)

function koa-validate.Validator.prototype.optional ()

function koa-validate.Validator.prototype.replace (a, b)

function koa-validate.Validator.prototype.rtrim (c)

function koa-validate.Validator.prototype.sha1 ()

function koa-validate.Validator.prototype.stripLow (nl)

function koa-validate.Validator.prototype.toBoolean ()

function koa-validate.Validator.prototype.toDate ()

function koa-validate.Validator.prototype.toFloat (tip)

function koa-validate.Validator.prototype.toInt (tip, radix, options)

function koa-validate.Validator.prototype.toJson (tip)

function koa-validate.Validator.prototype.toLow ()

function koa-validate.Validator.prototype.toLowercase ()

function koa-validate.Validator.prototype.toUp ()

function koa-validate.Validator.prototype.toUppercase ()

function koa-validate.Validator.prototype.trim (c)

function koa-validate.Validator.prototype.type (t, tip)

function koa-validate.Validator.prototype.whitelist (s)

[ this document was created with utility2 ]