FileValidator

Constructor

new FileValidator(context, key, value, exists, params, deleteOnCheckFailed)

Parameters:

Name	Type	Description
`context`	object	koa ctx instance
`key`	string	key to validate in request
`value`	object	value of key if exists
`exists`	bool	if key exists
`params`
`deleteOnCheckFailed`	bool	deletes file if any validation fails

Source:: validators.js, line 37

Extends

Validator

Methods

addError(tip)

Adds an error to the context

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#addError
Source:: lib/body_validators.js, line 11

blacklist(s)

remove characters that appear in the blacklist

Parameters:

Name	Type	Description
`s`	String

Overrides:: Validator#blacklist
Source:: lib/body_sanitizers.js, line 177

check(fn, tip, scope)

Runs passed in function and checks for returned boolean. Function will be passed scope if provided else will receive (value, key, context).

Parameters:

Name	Type	Description
`fn`	function	function to run that returns boolean
`tip`		tip for error if fn fails
`scope`		custom scope that can be passed into fn

Overrides:: Validator#check
Source:: lib/json_validators.js, line 11

clone(key, value)

clone current value to the new key, if newValue supplied , use it. this.checkBody('v1').clone('md5').md5(); then your can use this.request.body.md5

Parameters:

Name	Type	Description
`key`	String
`value`	Object

Overrides:: Validator#clone
Source:: lib/body_sanitizers.js, line 302

contains(s, tip)

check if the param contains the str

Parameters:

Name	Type	Description
`s`
`tip`	String	Message to return on fail

Overrides:: Validator#contains
Source:: lib/body_validators.js, line 280

contentTypeMatch(reg, tip)

Check the file's contentType with regular expression

Parameters:

Name	Type	Description
`reg`	RegExp
`tip`	String	message to return if test fails

Source:: lib/file_validators.js, line 37

copy(dst, afterCopy)

Move uploaded file to the target location.

Parameters:

Name	Type	Description
`dst`	String \| function	accepts params (fileObject,fieldName,context) returns String
`afterCopy`	function	accepts params (fileObject,fieldName,context)

Source:: lib/file_sanitizers.js, line 27

decodeBase64(inBuffer, tip)

decode current base64 to a normal string if inBuffer is true the value will be a Buffer

Parameters:

Name	Type	Description
`inBuffer`
`tip`

Overrides:: Validator#decodeBase64
Source:: lib/body_sanitizers.js, line 255

decodeURI(tip)

ref mdn decodeURI

Parameters:

Name	Type	Description
`tip`

Overrides:: Validator#decodeURI
Source:: lib/body_sanitizers.js, line 196

decodeURIComponent(tip)

ref mdn decodeURIComponent

Parameters:

Name	Type	Description
`tip`

Overrides:: Validator#decodeURIComponent
Source:: lib/body_sanitizers.js, line 219

default(d)

if the param not exits or is an empty string, it will take the default value

Parameters:

Name	Type	Description
`d`	Object	default value if it doesn't exist

Overrides:: Validator#default
Source:: lib/body_sanitizers.js, line 7

delete()

Deletes the uploaded file.

Source:: lib/file_sanitizers.js, line 55

empty()

the params can be a empty string

Overrides:: Validator#empty
Source:: lib/body_validators.js, line 53

encodeBase64()

encode current value to base64 string

Overrides:: Validator#encodeBase64
Source:: lib/body_sanitizers.js, line 243

encodeURI()

ref mdn encodeURI

Overrides:: Validator#encodeURI
Source:: lib/body_sanitizers.js, line 186

encodeURIComponent()

ref mdn encodeURIComponent

Overrides:: Validator#encodeURIComponent
Source:: lib/body_sanitizers.js, line 209

ensure(assertion, tip, shouldBail)

Ensure that assertion, an arbitrary value, is truthy.

Parameters:

Name	Type	Description
`assertion`
`tip`	String	Message to return on fail
`shouldBail`

Overrides:: Validator#ensure
Source:: lib/body_validators.js, line 123

ensureNot(assertion, tip, shouldBail)

Ensure that assertion, an arbitrary value, is falsey.

Parameters:

Name	Type	Description
`assertion`
`tip`	String	Message to return on fail
`shouldBail`

Overrides:: Validator#ensureNot
Source:: lib/body_validators.js, line 110

eq(l, tip)

check if the param equal to the value

Parameters:

Name	Type	Description
`l`
`tip`	String	Message to return on fail

Overrides:: Validator#eq
Source:: lib/body_validators.js, line 214

escape()

replace <, >, & and " with HTML entities

Overrides:: Validator#escape
Source:: lib/body_sanitizers.js, line 147

exist(tip)

Checks if key exists

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#exist
Source:: lib/body_validators.js, line 75

fileNameMatch(reg, tip)

Check the file's name with regular expression

Parameters:

Name	Type	Description
`reg`	RegExp
`tip`	String	message to return if test fails

Source:: lib/file_validators.js, line 64

filter(fn, scope)

Filter the value if value is array. fn format function(value,index,key,requestParams):boolean

Parameters:

Name	Type	Description
`fn`	function
`scope`	Object

Overrides:: Validator#filter
Source:: lib/json_validators.js, line 39

first()

Returns first value

Overrides:: Validator#first
Source:: lib/json_validators.js, line 30

ge(l, tip)

check if the param great then or equal the value

Parameters:

Name	Type	Description
`l`
`tip`	String	Message to return on fail

Overrides:: Validator#ge
Source:: lib/body_validators.js, line 258

get(index)

Returns value of given index

Parameters:

Name	Type	Description
`index`	int	index to retreive value at

Overrides:: Validator#get
Source:: lib/json_validators.js, line 21

gt(l, tip)

check if the param greater then the value

Parameters:

Name	Type	Description
`l`
`tip`	String	Message to return on fail

Overrides:: Validator#gt
Source:: lib/body_validators.js, line 236

hasError() → {boolean}

Overrides:: Validator#hasError
Source:: lib/body_validators.js, line 27

Returns:

Type: boolean

hash(alg, enc)

hash current value use specified algorithm and encoding(if supplied , default is 'hex'). see Hash

Parameters:

Name	Type	Description
`alg`
`enc`

Overrides:: Validator#hash
Source:: lib/body_sanitizers.js, line 275

in(arr, tip)

check if the param is in the array.

Parameters:

Name	Type	Description
`arr`
`tip`	String	Message to return on fail

Overrides:: Validator#in
Source:: lib/body_validators.js, line 191

isAfter(d, tip)

check if the param is a date that's after the specified date

Parameters:

Name	Type	Description
`d`	Date
`tip`	String	Message to return on fail

Overrides:: Validator#isAfter
Source:: lib/body_validators.js, line 502

isAlpha(tip, locale)

check if the param contains only letters (a-zA-Z)

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail
`locale`

Overrides:: Validator#isAlpha
Source:: lib/body_validators.js, line 335

isAlphanumeric(tip, locale)

check if the param contains only letters and numbers

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail
`locale`

Overrides:: Validator#isAlphanumeric
Source:: lib/body_validators.js, line 357

isAscii(tip)

check if the param contains ASCII chars only

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#isAscii
Source:: lib/body_validators.js, line 565

isBase64(tip)

check if a param is base64 encoded

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#isBase64
Source:: lib/body_validators.js, line 367

isBefore(d, tip)

check if the param is a date that's before the specified date

Parameters:

Name	Type	Description
`d`	Date
`tip`	String	Message to return on fail

Overrides:: Validator#isBefore
Source:: lib/body_validators.js, line 513

isByteLength(min, max, charset, tip)

check if the param's length (in bytes) falls in a range

Parameters:

Name	Type	Description
`min`	int
`max`	int
`charset`	String	default 'utf8'
`tip`	String	Message to return on fail

Overrides:: Validator#isByteLength
Source:: lib/body_validators.js, line 441

isCreditCard(tip)

check if the param is a credit card

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#isCreditCard
Source:: lib/body_validators.js, line 523

isCurrency(tip)

check if the param is a currency

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#isCurrency
Source:: lib/body_validators.js, line 615

isDataURI(tip)

check if the param is a data uri

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#isDataURI
Source:: lib/body_validators.js, line 625

isDate(tip)

check if the param is a date

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#isDate
Source:: lib/body_validators.js, line 479

isDivisibleBy(n, tip)

check if the param is a number that's divisible by another

Parameters:

Name	Type	Description
`n`
`tip`	String	Message to return on fail

Overrides:: Validator#isDivisibleBy
Source:: lib/body_validators.js, line 418

isEmail(tip, options)

check if the param is an email

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail
`options`

Overrides:: Validator#isEmail
Source:: lib/body_validators.js, line 302

isFloat(tip, options)

check if the param is float

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail
`options`

Overrides:: Validator#isFloat
Source:: lib/body_validators.js, line 147

isFQDN(tip, options)

Check if the param is a fully qualified domain name.

Parameters:

Name	Type	Description
`tip`	String
`options`

Overrides:: Validator#isFQDN
Source:: lib/body_validators.js, line 677

isFullWidth(tip)

check if the param contains any full-width chars

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#isFullWidth
Source:: lib/body_validators.js, line 575

isHalfWidth(tip)

check if the param contains any half-width chars

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#isHalfWidth
Source:: lib/body_validators.js, line 585

isHexadecimal(tip)

check if the param is a hexadecimal number

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#isHexadecimal
Source:: lib/body_validators.js, line 377

isHexColor(tip)

check if the param is a hexadecimal color

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#isHexColor
Source:: lib/body_validators.js, line 387

isImageContentType(tip)

Check if content type is of image.

Parameters:

Name	Type	Description
`tip`	String	message to return if test fails

Source:: lib/file_validators.js, line 50

isInt(tip, options)

check if the param is integer

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail
`options`

Overrides:: Validator#isInt
Source:: lib/body_validators.js, line 136

isIp(tip, version)

check if the param is an IP (version 4 or 6)

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail
`version`

Overrides:: Validator#isIp
Source:: lib/body_validators.js, line 324

isISBN(tip, version)

check if the param is an ISBN (version 10 or 13)

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail
`version`

Overrides:: Validator#isISBN
Source:: lib/body_validators.js, line 534

isISIN(tip)

check if the param is a ISIN

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#isISIN
Source:: lib/body_validators.js, line 666

isISO8601(tip)

check if the param is a ISO8601 string

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#isISO8601
Source:: lib/body_validators.js, line 645

isJSON(tip)

check if the param is valid JSON (note: uses JSON.parse)

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#isJSON
Source:: lib/body_validators.js, line 544

isLength(min, max, tip)

check the param length.

Parameters:

Name	Type	Description
`min`
`max`
`tip`	String	Message to return on fail

Overrides:: Validator#isLength
Source:: lib/body_validators.js, line 160

isLowercase(tip)

check if the param is lowercase

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#isLowercase
Source:: lib/body_validators.js, line 397

isMACAddress(tip)

check if the param is a MAC address

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#isMACAddress
Source:: lib/body_validators.js, line 655

isMobilePhone(tip)

check if the param is a mobile phone

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#isMobilePhone
Source:: lib/body_validators.js, line 635

isMultibyte(tip)

check if the param contains one or more multibyte chars

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#isMultibyte
Source:: lib/body_validators.js, line 555

isNull(tip)

check if the param is null

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#isNull
Source:: lib/body_validators.js, line 428

isNumeric(tip)

check if the param contains only numbers

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#isNumeric
Source:: lib/body_validators.js, line 345

isSurrogatePair(tip)

check if the param contains any surrogate pairs chars

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#isSurrogatePair
Source:: lib/body_validators.js, line 605

isTime(tip)

check if param is a time

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#isTime
Source:: lib/body_validators.js, line 489

isUppercase(tip)

check if the param is uppercase

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#isUppercase
Source:: lib/body_validators.js, line 407

isUrl(tip, options)

check if the param is an URL

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail
`options`

Overrides:: Validator#isUrl
Source:: lib/body_validators.js, line 313

isUUID(tip, ver)

check if the param is a UUID (version 3, 4 or 5)

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail
`ver`	int

Overrides:: Validator#isUUID
Source:: lib/body_validators.js, line 469

isVariableWidth(tip)

check if the param contains a mixture of full and half-width chars

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#isVariableWidth
Source:: lib/body_validators.js, line 595

le(l, tip)

check if the param less then or equal the value

Parameters:

Name	Type	Description
`l`
`tip`	String	Message to return on fail

Overrides:: Validator#le
Source:: lib/body_validators.js, line 269

lt(l, tip)

check if the param less then the value

Parameters:

Name	Type	Description
`l`
`tip`	String	Message to return on fail

Overrides:: Validator#lt
Source:: lib/body_validators.js, line 247

ltrim(c)

trim characters from the left-side of the param

Parameters:

Name	Type	Description
`c`

Overrides:: Validator#ltrim
Source:: lib/body_sanitizers.js, line 128

match(reg, tip)

pattern must be a RegExp instance ,eg. /abc/i

Parameters:

Name	Type	Description
`reg`
`tip`	String	Message to return on fail

Overrides:: Validator#match
Source:: lib/body_validators.js, line 86

md5()

md5 current value into hex string

Overrides:: Validator#md5
Source:: lib/body_sanitizers.js, line 285

move(dst, afterMove)

Move upload file to the target location. If target ends with '/' or '',the target will be deemed as directory.

Parameters:

Name	Type	Description
`dst`	String \| function	accepts params (fileObject,fieldName,context) returns String
`afterMove`	function	accepts params (fileObject,fieldName,context)

Source:: lib/file_sanitizers.js, line 12

neq(l, tip)

check if the param not equal to the value

Parameters:

Name	Type	Description
`l`
`tip`	String	Message to return on fail

Overrides:: Validator#neq
Source:: lib/body_validators.js, line 225

notBlank(tip)

check if the param is not blank,use /^\s*$/gi reg to check.

Parameters:

Name	Type	Description
`tip`	String	Message to return on fail

Overrides:: Validator#notBlank
Source:: lib/body_validators.js, line 65

notContains(s, tip)

check if the param not contains the str

Parameters:

Name	Type	Description
`s`
`tip`	String	Message to return on fail

Overrides:: Validator#notContains
Source:: lib/body_validators.js, line 291

notEmpty(tip)

Checks that file is not empty

Parameters:

Name	Type	Description
`tip`	String	message to return if test fails

Overrides:: Validator#notEmpty
Source:: lib/file_validators.js, line 7

notMatch(reg, tip)

Ensure that a string does not match the supplied regular expression.

Parameters:

Name	Type	Description
`reg`
`tip`	String	Message to return on fail

Overrides:: Validator#notMatch
Source:: lib/body_validators.js, line 98

optional()

The param may not in the params. If the param not exists,it has no error,no matter whether have other checker or not.

Overrides:: Validator#optional
Source:: lib/body_validators.js, line 34

replace(a, b)

the same as String replace

Parameters:

Name	Type	Description
`a`	String
`b`	String

Overrides:: Validator#replace
Source:: lib/body_sanitizers.js, line 234

rtrim(c)

trim characters from the right-side of the param.

Parameters:

Name	Type	Description
`c`

Overrides:: Validator#rtrim
Source:: lib/body_sanitizers.js, line 138

sha1()

sha1 current value into hex string

Overrides:: Validator#sha1
Source:: lib/body_sanitizers.js, line 292

size(min, max, tip)

Checks size of file is between values

Parameters:

Name	Type	Description
`min`	int	minimum file size
`max`	int	maximum file size
`tip`	String	message to return if test fails

Source:: lib/file_validators.js, line 23

stripLow(nl)

remove characters with a numerical value < 32 and 127, mostly control characters

Parameters:

Name	Type	Description
`nl`

Overrides:: Validator#stripLow
Source:: lib/body_sanitizers.js, line 157

suffixIn(arr, tip)

Check the suffix of file's if in specified arr. arr eg. ['png','jpg']

Parameters:

Name	Type	Description
`arr`	Array
`tip`	String	message to return if test fails

Source:: lib/file_validators.js, line 78

toBoolean()

Convert the param to a boolean. Everything except for '0', 'false' and '' returns true. In strict mode only '1' and 'true' return true.

Overrides:: Validator#toBoolean
Source:: lib/body_sanitizers.js, line 103

toDate()

convert param to js Date object.

Overrides:: Validator#toDate
Source:: lib/body_sanitizers.js, line 16

toFloat(tip)

convert param to float

Parameters:

Name	Type	Description
`tip`

Overrides:: Validator#toFloat
Source:: lib/body_sanitizers.js, line 43

toInt(tip, radix, options)

convert param to integer.radix for toInt,options for isInt

Parameters:

Name	Type	Description
`tip`
`radix`
`options`

Overrides:: Validator#toInt
Source:: lib/body_sanitizers.js, line 29

toJson(tip)

convert param to json object

Parameters:

Name	Type	Description
`tip`

Overrides:: Validator#toJson
Source:: lib/body_sanitizers.js, line 57

toLowerCase()

convert param to lowercase

Overrides:: Validator#toLowerCase
Source:: lib/body_sanitizers.js, line 73

toUpperCase()

Convert param to uppercase

Overrides:: Validator#toUpperCase
Source:: lib/body_sanitizers.js, line 87

trim(c)

trim characters (whitespace by default) from both sides of the param.

Parameters:

Name	Type	Description
`c`

Overrides:: Validator#trim
Source:: lib/body_sanitizers.js, line 118

type(t, tip)

Checks if value is of type

Parameters:

Name	Type	Description
`t`	Object	type to match
`tip`	String	message to send if fails

Overrides:: Validator#type
Source:: lib/json_validators.js, line 57

whitelist(s)

remove characters that do not appear in the whitelist.

Parameters:

Name	Type	Description
`s`	String

Overrides:: Validator#whitelist
Source:: lib/body_sanitizers.js, line 167