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;
    };
    isIP?: boolean | {
        msg: string;
    };
    isIPv4?: boolean | {
        msg: string;
    };
    isIPv6?: boolean | {
        msg: string;
    };
    isIn?: readonly (readonly any[])[] | {
        args: readonly (readonly any[])[];
        msg: string;
    };
    isInt?: boolean | {
        msg: string;
    };
    isLowercase?: boolean | {
        msg: string;
    };
    isNull?: boolean | {
        msg: string;
    };
    isNumeric?: boolean | {
        msg: string;
    };
    isUUID?: number | {
        args: number;
        msg: string;
    };
    isUppercase?: boolean | {
        msg: string;
    };
    isUrl?: boolean | {
        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? isIP? isIPv4? isIPv6? isIn? isInt? isLowercase? isNull? isNumeric? isUUID? isUppercase? isUrl? len? max? min? not? notContains? notEmpty? notIn? notNull?

Properties

Optional contains

contains?: string | {
    msg: string;
}

force specific substrings

Type declaration

  • msg: string

Optional equals

equals?: string | {
    msg: string;
}

only allow a specific value

Type declaration

  • msg: string

Optional is

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

Type declaration

  • args: string | RegExp | readonly (string | RegExp)[]
  • msg: string

Optional isAfter

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

only allow date strings after a specific date

Type declaration

  • args: string
  • msg: string

Optional isAlpha

isAlpha?: boolean | {
    msg: string;
}

will only allow letters

Type declaration

  • msg: string

Optional isAlphanumeric

isAlphanumeric?: boolean | {
    msg: string;
}

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

Type declaration

  • msg: string

Optional isArray

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

only allow arrays

Type declaration

  • args: boolean
  • msg: string

Optional isBefore

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

only allow date strings before a specific date

Type declaration

  • args: string
  • msg: string

Optional isCreditCard

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

check for valid credit card numbers

Type declaration

  • args: boolean
  • msg: string

Optional isDate

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

only allow date strings

Type declaration

  • args: boolean
  • msg: string

Optional isDecimal

isDecimal?: boolean | {
    msg: string;
}

checks for any numbers

Type declaration

  • msg: string

Optional isEmail

isEmail?: boolean | {
    msg: string;
}

checks for email format (foo@bar.com)

Type declaration

  • msg: string

Optional isFloat

isFloat?: boolean | {
    msg: string;
}

checks for valid floating point numbers

Type declaration

  • msg: string

Optional isIP

isIP?: boolean | {
    msg: string;
}

checks for IPv4 (129.89.23.1) or IPv6 format

Type declaration

  • msg: string

Optional isIPv4

isIPv4?: boolean | {
    msg: string;
}

checks for IPv4 (129.89.23.1)

Type declaration

  • msg: string

Optional isIPv6

isIPv6?: boolean | {
    msg: string;
}

checks for IPv6 format

Type declaration

  • msg: string

Optional isIn

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

check the value is one of these

Type declaration

  • args: readonly (readonly any[])[]
  • msg: string

Optional isInt

isInt?: boolean | {
    msg: string;
}

checks for valid integers

Type declaration

  • msg: string

Optional isLowercase

isLowercase?: boolean | {
    msg: string;
}

checks for lowercase

Type declaration

  • msg: string

Optional isNull

isNull?: boolean | {
    msg: string;
}

only allows null

Type declaration

  • msg: string

Optional isNumeric

isNumeric?: boolean | {
    msg: string;
}

will only allow numbers

Type declaration

  • msg: string

Optional isUUID

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

only allow uuids

Type declaration

  • args: number
  • msg: string

Optional isUppercase

isUppercase?: boolean | {
    msg: string;
}

checks for uppercase

Type declaration

  • msg: string

Optional isUrl

isUrl?: boolean | {
    msg: string;
}

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

Type declaration

  • msg: string

Optional len

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

only allow values with length between 2 and 10

Type declaration

  • args: readonly [number, number]
  • msg: string

Optional max

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

only allow values

Type declaration

  • args: readonly [number]
  • msg: string

Optional min

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

only allow values >= 23

Type declaration

  • args: readonly [number]
  • msg: string

Optional not

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

Type declaration

  • args: string | RegExp | readonly (string | RegExp)[]
  • msg: string

Optional notContains

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

don't allow specific substrings

Type declaration

  • args: string | readonly string[]
  • msg: string

Optional notEmpty

notEmpty?: boolean | {
    msg: string;
}

don't allow empty strings

Type declaration

  • msg: string

Optional notIn

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

check the value is not one of these

Type declaration

  • args: readonly (readonly any[])[]
  • msg: string

Optional notNull

notNull?: boolean | {
    msg: string;
}

won't allow null

Type declaration

  • msg: string

Settings

Member Visibility

Theme

On This Page

containsequalsisisAfterisAlphaisAlphanumericisArrayisBeforeisCreditCardisDateisDecimalisEmailisFloatisIPisIPv4isIPv6isInisIntisLowercaseisNullisNumericisUUIDisUppercaseisUrllenmaxminnotnotContainsnotEmptynotInnotNull