Class Validate

Validation methods for DataTables Editor fields. All of the methods defined in this class return a function that can be used by Field instance's Field.validator method.

Each method may define its own parameters that configure how the formatter operates. For example the minLen validator takes information on the minimum length of value to accept.

Additionally each method can optionally take a ValidationOptions instance that controls common validation options and error messages.

The validation functions return true for valid data and a string for invalid data, with the string being the error message.

Validator

Index

Constructors

constructor

Properties

Host Options

Constructors

constructor

new Validate(): Validate
Returns Validate

Properties

`Static`Host

Host: typeof default = ValidationHost

`Static`Options

Options: typeof default = ValidationOptions

Methods

`Static`basic

basic(cfg?: default | null): IValidator
Basic validation - this is used to perform the validation provided by the validation options only. If the validation options pass (e.g. required, empty and optional) then the validation will pass regardless of the actual value.
Parameters
- Optionalcfg: default | null = null
  Validation options
Returns IValidator
Configured validation function
- Defined in validators.ts:68

`Static`boolean

boolean(cfg?: default | null): IValidator
Validate an input as a boolean value.
Parameters
- Optionalcfg: default | null = null
  Validation options
Returns IValidator
Configured validation function
- Defined in validators.ts:131

`Static`dateFormat

dateFormat(
    format: string,
    locale?: string | null,
    cfg?: default | null,
): IValidator
Check that a valid date input is given. Uses MomentJS
Parameters
- format: string
  MomentJS date format
- Optionallocale: string | null = null
  MomentJS locale
- Optionalcfg: default | null = null
  Validation options
Returns IValidator
Configured validation function
- Defined in validators.ts:598

`Static`dbUnique

dbUnique(
    cfg?: default | null,
    column?: string | null,
    table?: string | null,
    db?: Knex<any, any[]> | null,
): IValidator
Check that the given value is unique in the database
Parameters
- Optionalcfg: default | null = null
  Validation options
- Optionalcolumn: string | null = null
  Column name to use to check as a unique value. If not given the host field's database column name is used
- Optionaltable: string | null = null
  Table to check that this value is uniquely valid on. If not given the host Editor's table name is used
- Optionaldb: Knex<any, any[]> | null = null
  Database connection. If not given the host Editor's database connection is used
Returns IValidator
Configured validation function
- Defined in validators.ts:639

`Static`dbValues

dbValues(
    cfg?: default | null,
    column?: string | null,
    table?: string | null,
    db?: Knex<any, any[]> | null,
    values?: any[],
): IValidator
Check that the given value is a value that is available in a database - i.e. a join primary key. This will attempt to automatically use the table name and value column from the field's Options method (under the assumption that it will typically be used with a joined field), but the table and field can also be specified via the options.
Parameters
- Optionalcfg: default | null = null
  Validation options
- Optionalcolumn: string | null = null
  Column name to use to check as a unique value. If not given the host field's database column name is used
- Optionaltable: string | null = null
  Table to check that this value is uniquely valid on. If not given the host Editor's table name is used
- Optionaldb: Knex<any, any[]> | null = null
  Database connection. If not given the host Editor's database connection is used
- values: any[] = []
Returns IValidator
Configured validation function
- Defined in validators.ts:703

`Static`email

email(cfg?: default | null): IValidator
Validate an input as an e-mail address.
Parameters
- Optionalcfg: default | null = null
  Validation options
Returns IValidator
Configured validation function
- Defined in validators.ts:346

`Static`fileExtensions

fileExtensions(extns: string[], msg: string): IFileValidator
Check that the uploaded file has a given extension
Parameters
- extns: string[]
  Allowed extensions
- msg: string
  Error message to return if not valid
Returns IFileValidator
Configured validation function
- Defined in validators.ts:768

`Static`fileSize

fileSize(size: number, msg: string): IFileValidator
Check that the uploaded file is equal or less than a given size.
Parameters
- size: number
  Max file size in bytes
- msg: string
Returns IFileValidator
Configured validation function
- Defined in validators.ts:786

`Static`ip

ip(cfg?: default | null): IValidator
Validate as an IP address.
Parameters
- Optionalcfg: default | null = null
  Validation options
Returns IValidator
Configured validation function
- Defined in validators.ts:455

`Static`maxLen

maxLen(max: number, cfg?: default | null): IValidator
Validate a string is less or equal to a maximum length.
Parameters
- max: number
  Maximum length
- Optionalcfg: default | null = null
  Validation options
Returns IValidator
Configured validation function
- Defined in validators.ts:400

`Static`maxNum

maxNum(max: number, decimal?: string, cfg?: default | null): IValidator
Check for a numeric input and that it is less than a given value.
Parameters
- max: number
  Maximum value
- Optionaldecimal: string = '.'
  Character to use as the decimal place
- Optionalcfg: default | null = null
  Validation options
Returns IValidator
Configured validation function
- Defined in validators.ts:268

`Static`minLen

minLen(min: number, cfg?: default | null): IValidator
Validate a string has a minimum length.
Parameters
- min: number
  Minimum length
- Optionalcfg: default | null = null
  Validation options
Returns IValidator
Configured validation function
- Defined in validators.ts:373

`Static`minMaxLen

minMaxLen(min: number, max: number, cfg?: default | null): IValidator
Require a string with a certain minimum or maximum number of characters.
Parameters
- min: number
  Minimum length
- max: number
  Maximum length
- Optionalcfg: default | null = null
  Validation options
Returns IValidator
Configured validation function
- Defined in validators.ts:428

`Static`minMaxNum

minMaxNum(
    min: number,
    max: number,
    decimal?: string,
    cfg?: default | null,
): IValidator
Check for a numeric input and that it is in between two given values.
Parameters
- min: number
  Minimum value
- max: number
  Maximum value
- Optionaldecimal: string = '.'
  Character to use as the decimal place
- Optionalcfg: default | null = null
  Validation options
Returns IValidator
Configured validation function
- Defined in validators.ts:306

`Static`minNum

minNum(min: number, decimal?: string, cfg?: default | null): IValidator
Check for a numeric input and that it is greater than a given value.
Parameters
- min: number
  Minimum value
- Optionaldecimal: string = '.'
  Character to use as the decimal place
- Optionalcfg: default | null = null
  Validation options
Returns IValidator
Configured validation function
- Defined in validators.ts:225

`Static`mjoinMaxCount

mjoinMaxCount(size: number, msg: string): IMjoinValidator
Require a maximum value of the number of options / values submitted in an array
Parameters
- size: number
  Max array size required to be valid
- msg: string
  Error message
Returns IMjoinValidator
Configured validation function
- Defined in validators.ts:821

`Static`mjoinMinCount

mjoinMinCount(size: number, msg: string): IMjoinValidator
Require a minimum value of the number of options / values submitted in an array
Parameters
- size: number
  Min array size required to be valid
- msg: string
  Error message
Returns IMjoinValidator
Configured validation function
- Defined in validators.ts:804

`Static`none

none(cfg?: default | null): IValidator
No validation - all inputs are valid
Parameters
- Optionalcfg: default | null = null
  Validation options
Returns IValidator
Configured validation function
- Defined in validators.ts:49

`Static`noTags

noTags(cfg?: default | null): IValidator
Ensure that the submitted string does not contain HTML tags
Parameters
- Optionalcfg: default | null = null
  Validation options
Returns IValidator
Configured validation function
- Defined in validators.ts:569

`Static`notEmpty

notEmpty(cfg?: default | null): IValidator
Optional field, but if given there must be a non-empty value
Parameters
- Optionalcfg: default | null = null
  Validation options
Returns IValidator
Configured validation function
- Defined in validators.ts:110

`Static`numeric

numeric(decimal?: string, cfg?: default | null): IValidator
Check that any input is numeric.
Parameters
- Optionaldecimal: string = '.'
  Character to use as the decimal place
- Optionalcfg: default | null = null
  Validation options
Returns IValidator
Configured validation function
- Defined in validators.ts:184

`Static`required

required(cfg?: default | null): IValidator
Required field - there must be a value and it must be a non-empty value
Parameters
- Optionalcfg: default | null = null
  Validation options
Returns IValidator
Configured validation function
- Defined in validators.ts:88

`Static`url

url(cfg?: default | null): IValidator
Validate as a URL.
Parameters
- Optionalcfg: default | null = null
  Validation options
Returns IValidator
Configured validation function
- Defined in validators.ts:494

`Static`values

values(values: any[], cfg?: default | null): IValidator
Confirm that the value submitted is in a list of allowable values
Parameters
- values: any[]
  List of values that are valid
- Optionalcfg: default | null = null
  Validation options
Returns IValidator
Configured validation function
- Defined in validators.ts:543

`Static`xss

xss(cfg?: default | null): IValidator
Check if string could contain an XSS attack string
Parameters
- Optionalcfg: default | null = null
  Validation options
Returns IValidator
Configured validation function
- Defined in validators.ts:517

Class Validate

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Validate

Properties

StaticHost

StaticOptions

Methods

Staticbasic

Parameters

Returns IValidator

Staticboolean

Parameters

Returns IValidator

StaticdateFormat

Parameters

Returns IValidator

StaticdbUnique

Parameters

Returns IValidator

StaticdbValues

Parameters

Returns IValidator

Staticemail

Parameters

Returns IValidator

StaticfileExtensions

Parameters

Returns IFileValidator

StaticfileSize

Parameters

Returns IFileValidator

Staticip

Parameters

Returns IValidator

StaticmaxLen

Parameters

Returns IValidator

StaticmaxNum

Parameters

Returns IValidator

StaticminLen

Parameters

Returns IValidator

StaticminMaxLen

Parameters

Returns IValidator

StaticminMaxNum

Parameters

Returns IValidator

StaticminNum

Parameters

Returns IValidator

StaticmjoinMaxCount

Parameters

Returns IMjoinValidator

StaticmjoinMinCount

Parameters

Returns IMjoinValidator

Staticnone

Parameters

Returns IValidator

StaticnoTags

Parameters

Returns IValidator

StaticnotEmpty

Parameters

Returns IValidator

Staticnumeric

Parameters

Returns IValidator

Staticrequired

Parameters

Returns IValidator

Staticurl

Parameters

`Static`Host

`Static`Options

`Static`basic

`Static`boolean

`Static`dateFormat

`Static`dbUnique

`Static`dbValues

`Static`email

`Static`fileExtensions

`Static`fileSize

`Static`ip

`Static`maxLen

`Static`maxNum

`Static`minLen

`Static`minMaxLen

`Static`minMaxNum

`Static`minNum

`Static`mjoinMaxCount

`Static`mjoinMinCount

`Static`none

`Static`noTags

`Static`notEmpty

`Static`numeric

`Static`required

`Static`url

`Static`values

`Static`xss