Interface ColumnValidateOptions

Model validations, allow you to specify format/content/inheritance validations for each attribute of the model.

Validations are automatically run on create, update and save. You can also call validate() to manually validate an instance.

The validations are implemented by validator.js.

interface ColumnValidateOptions {
    contains?: string | { msg: string };
    equals?: string | { msg: string };
    is?:
        | string
        | RegExp
        | readonly (string | RegExp)[]
        | { args: string | RegExp | readonly (string | RegExp)[]; msg: string };
    isAfter?: string | { args: string; msg: string };
    isAlpha?: boolean | { msg: string };
    isAlphanumeric?: boolean | { msg: string };
    isArray?: boolean | { args: boolean; msg: string };
    isBefore?: string | { args: string; msg: string };
    isCreditCard?: boolean | { args: boolean; msg: string };
    isDate?: boolean | { args: boolean; msg: string };
    isDecimal?: boolean | { msg: string };
    isEmail?: boolean | { msg: string };
    isFloat?: boolean | { msg: string };
    isIn?:
        | readonly (readonly any[])[]
        | { args: readonly (readonly any[])[]; msg: string };
    isInt?: boolean | { msg: string };
    isIP?: boolean | { msg: string };
    isIPv4?: boolean | { msg: string };
    isIPv6?: boolean | { msg: string };
    isLowercase?: boolean | { msg: string };
    isNull?: boolean | { msg: string };
    isNumeric?: boolean | { msg: string };
    isUppercase?: boolean | { msg: string };
    isUrl?: boolean | { msg: string };
    isUUID?: number | { args: number; msg: string };
    len?:
        | readonly [number, number]
        | { args: readonly [number, number]; msg: string };
    max?: number | { args: readonly [number]; msg: string };
    min?: number | { args: readonly [number]; msg: string };
    not?:
        | string
        | RegExp
        | readonly (string | RegExp)[]
        | { args: string | RegExp | readonly (string | RegExp)[]; msg: string };
    notContains?:
        | string
        | readonly string[]
        | { args: string
        | readonly string[]; msg: string };
    notEmpty?: boolean | { msg: string };
    notIn?:
        | readonly (readonly any[])[]
        | { args: readonly (readonly any[])[]; msg: string };
    notNull?: boolean | { msg: string };
    [name: string]: unknown;
}

Indexable

  • [name: string]: unknown

    Custom validations are also possible

Properties

contains? equals? is? isAfter? isAlpha? isAlphanumeric? isArray? isBefore? isCreditCard? isDate? isDecimal? isEmail? isFloat? isIn? isInt? isIP? isIPv4? isIPv6? isLowercase? isNull? isNumeric? isUppercase? isUrl? isUUID? len? max? min? not? notContains? notEmpty? notIn? notNull?

Properties

Optionalcontains

contains?: string | { msg: string }

force specific substrings

Optionalequals

equals?: string | { msg: string }

only allow a specific value

Optionalis

is?:
    | string
    | RegExp
    | readonly (string | RegExp)[]
    | { args: string | RegExp | readonly (string | RegExp)[]; msg: string }
  • { is: ['^[a-z]+$','i'] } will only allow letters
  • { is: /^[a-z]+$/i } also only allows letters

OptionalisAfter

isAfter?: string | { args: string; msg: string }

only allow date strings after a specific date

OptionalisAlpha

isAlpha?: boolean | { msg: string }

will only allow letters

OptionalisAlphanumeric

isAlphanumeric?: boolean | { msg: string }

will only allow alphanumeric characters, so "_abc" will fail

OptionalisArray

isArray?: boolean | { args: boolean; msg: string }

only allow arrays

OptionalisBefore

isBefore?: string | { args: string; msg: string }

only allow date strings before a specific date

OptionalisCreditCard

isCreditCard?: boolean | { args: boolean; msg: string }

check for valid credit card numbers

OptionalisDate

isDate?: boolean | { args: boolean; msg: string }

only allow date strings

OptionalisDecimal

isDecimal?: boolean | { msg: string }

checks for any numbers

OptionalisEmail

isEmail?: boolean | { msg: string }

checks for email format (foo@bar.com)

OptionalisFloat

isFloat?: boolean | { msg: string }

checks for valid floating point numbers

OptionalisIn

isIn?:
    | readonly (readonly any[])[]
    | { args: readonly (readonly any[])[]; msg: string }

check the value is one of these

OptionalisInt

isInt?: boolean | { msg: string }

checks for valid integers

OptionalisIP

isIP?: boolean | { msg: string }

checks for IPv4 (129.89.23.1) or IPv6 format

OptionalisIPv4

isIPv4?: boolean | { msg: string }

checks for IPv4 (129.89.23.1)

OptionalisIPv6

isIPv6?: boolean | { msg: string }

checks for IPv6 format

OptionalisLowercase

isLowercase?: boolean | { msg: string }

checks for lowercase

OptionalisNull

isNull?: boolean | { msg: string }

only allows null

OptionalisNumeric

isNumeric?: boolean | { msg: string }

will only allow numbers

OptionalisUppercase

isUppercase?: boolean | { msg: string }

checks for uppercase

OptionalisUrl

isUrl?: boolean | { msg: string }

checks for url format (http://foo.com)

OptionalisUUID

isUUID?: number | { args: number; msg: string }

only allow uuids

Optionallen

len?:
    | readonly [number, number]
    | { args: readonly [number, number]; msg: string }

only allow values with length between 2 and 10

Optionalmax

max?: number | { args: readonly [number]; msg: string }

only allow values

Optionalmin

min?: number | { args: readonly [number]; msg: string }

only allow values >= 23

Optionalnot

not?:
    | string
    | RegExp
    | readonly (string | RegExp)[]
    | { args: string | RegExp | readonly (string | RegExp)[]; msg: string }
  • { not: ['[a-z]','i'] } will not allow letters

OptionalnotContains

notContains?:
    | string
    | readonly string[]
    | { args: string
    | readonly string[]; msg: string }

don't allow specific substrings

OptionalnotEmpty

notEmpty?: boolean | { msg: string }

don't allow empty strings

OptionalnotIn

notIn?:
    | readonly (readonly any[])[]
    | { args: readonly (readonly any[])[]; msg: string }

check the value is not one of these

OptionalnotNull

notNull?: boolean | { msg: string }

won't allow null

Settings

Member Visibility

On This Page

Properties