API Docs for: 0.8.0
Show:

ValidationService Class

Defined in: include/validation/validation_service.js:27
Module: Services

Provides a set of functions for common validations.

Constructor

ValidationService

()

Defined in include/validation/validation_service.js:27

Item Index

Methods

Properties

  • static
  • static
  • static
  • static
  • static

Methods

isArray

(
  • value
  • [required=false]
)

Defined in include/validation/validation_service.js:297

Validates an array

Parameters:

  • value Array
  • [required=false] Boolean optional

isBool

(
  • val
)
Boolean static

Defined in include/validation/validation_service.js:397

Validates that the value is a boolean.

Parameters:

  • val

    The value under test

Returns:

Boolean:

TRUE if the value is valid, FALSE if not

isDate

(
  • val
  • [required=false]
)
Boolean static

Defined in include/validation/validation_service.js:420

Validates that the value is a date object

Parameters:

  • val

    The value under test

  • [required=false] Boolean optional

Returns:

Boolean:

TRUE if the value is valid, FALSE if not

isEmail

(
  • value
  • [required=false]
)

Defined in include/validation/validation_service.js:129

Validates an email address

Parameters:

  • value String
  • [required=false] Boolean optional

isEmpty

(
  • val
)
Boolean static

Defined in include/validation/validation_service.js:408

Validates that the value is null, defined, an empty object, and empty array or an empty string.

Parameters:

  • val

    The value under test

Returns:

Boolean:

TRUE if the value is valid, FALSE if not

isFloat

(
  • val
  • [required=false]
  • strict
)
Boolean static

Defined in include/validation/validation_service.js:358

Validates that the value is a float.

Parameters:

  • val

    The value under test

  • [required=false] Boolean optional

    Indicates if the value is required. When FALSE, null will be an acceptable value.

  • strict Boolean

    Indicates if the value must be a number rather than a string representing a number.

Returns:

Boolean:

TRUE if the value is valid, FALSE if not

isId

(
  • val
  • [required=false]
)
Boolean static

Defined in include/validation/validation_service.js:100

Checks to see if the value is a valid ID string or an instance of ObjectID.

Parameters:

  • val String | ObjectID

    The value under test

  • [required=false] Boolean optional

    Indicates if the value is required. When FALSE, null will be an acceptable value.

Returns:

Boolean:

TRUE if the value is valid, FALSE if not

isIdStr

(
  • val
  • [required=false]
)
Boolean static

Defined in include/validation/validation_service.js:81

Checks to see if the value is a valid ID string

Parameters:

  • val String

    The value under test

  • [required=false] Boolean optional

    Indicates if the value is required. When FALSE, null will be an acceptable value.

Returns:

Boolean:

TRUE if the value is valid, FALSE if not

isInt

(
  • val
  • [required=false]
  • strict
)
Boolean static

Defined in include/validation/validation_service.js:336

Validates that the value is an integer.

Parameters:

  • val Integer

    The value under test

  • [required=false] Boolean optional

    Indicates if the value is required. When FALSE, null will be an acceptable value.

  • strict Boolean

    Indicates if the value must be a number rather than a string representing a number.

Returns:

Boolean:

TRUE if the value is valid, FALSE if not

isNonEmptyStr

(
  • value
  • [required=false]
)

Defined in include/validation/validation_service.js:272

Validates a string is not empty

Parameters:

  • value String
  • [required=false] Boolean optional

isNum

(
  • val
  • [required=false]
)
Boolean static

Defined in include/validation/validation_service.js:380

Validates that the value is a number.

Parameters:

  • val

    The value under test

  • [required=false] Boolean optional

    Indicates if the value is required. When FALSE, null will be an acceptable value.

Returns:

Boolean:

TRUE if the value is valid, FALSE if not

isObject

(
  • value
  • [required=false]
)

Defined in include/validation/validation_service.js:322

Validates an object

Parameters:

  • value Object
  • [required=false] Boolean optional

isSafeFileName

(
  • value
  • [required=false]
)

Defined in include/validation/validation_service.js:221

Validates a file name

Parameters:

  • value String
  • [required=false] Boolean optional

isStr

(
  • value
  • [required=false]
)

Defined in include/validation/validation_service.js:247

Validates a string

Parameters:

  • value String
  • [required=false] Boolean optional

isUrl

(
  • value
  • [required=false]
)

Defined in include/validation/validation_service.js:195

Validates an URL

Parameters:

  • value String
  • [required=false] Boolean optional

isVersionExpression

(
  • expression
  • [required=false]
)

Defined in include/validation/validation_service.js:170

Validates a version expression

Parameters:

  • expression String
  • [required=false] Boolean optional

isVersionNum

(
  • value
  • [required=false]
)

Defined in include/validation/validation_service.js:155

Validates a version number

Parameters:

  • value String
  • [required=false] Boolean optional

validateArray

(
  • value
  • [required=false]
)
deprecated

Defined in include/validation/validation_service.js:286

Validates an array

Parameters:

  • value Array
  • [required=false] Boolean optional

validateEmail

(
  • value
  • [required=false]
)
deprecated

Defined in include/validation/validation_service.js:118

Validates an email address

Parameters:

  • value String
  • [required=false] Boolean optional

validateNonEmptyStr

(
  • value
  • [required=false]
)
deprecated

Defined in include/validation/validation_service.js:261

Validates a string is not empty

Parameters:

  • value String
  • [required=false] Boolean optional

validateObject

(
  • value
  • [required=false]
)
deprecated

Defined in include/validation/validation_service.js:311

Validates an object

Parameters:

  • value Object
  • [required=false] Boolean optional

validateSafeFileName

(
  • value
  • [required=false]
)
deprecated

Defined in include/validation/validation_service.js:210

Validates a file name

Parameters:

  • value String
  • [required=false] Boolean optional

validateStr

(
  • value
  • [required=false]
)
deprecated

Defined in include/validation/validation_service.js:236

Validates a string

Parameters:

  • value String
  • [required=false] Boolean optional

validateUrl

(
  • value
  • [required=false]
)
deprecated

Defined in include/validation/validation_service.js:184

Validates an URL

Parameters:

  • value String
  • [required=false] Boolean optional

validateVersionNum

(
  • value
  • [required=false]
)
deprecated

Defined in include/validation/validation_service.js:144

Validates a version number

Parameters:

  • value String
  • [required=false] Boolean optional

Properties

RegExp private static

Defined in include/validation/validation_service.js:36

Pattern to validate a file name

RegExp private static

Defined in include/validation/validation_service.js:45

Pattern to validate a semantic package version

RegExp private static

Defined in include/validation/validation_service.js:54

A pattern to validate an email address

RegExp private static

Defined in include/validation/validation_service.js:63

A pattern to validate a fully qualified URL

RegExp private static

Defined in include/validation/validation_service.js:72

A pattern to validate a relative URL (no protocol, host, or port)