Interface ModelValidateOptions

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.

Hierarchy

  • ModelValidateOptions

Indexable

[name: string]: unknown

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

Optional equals

equals?: string | {
    msg: string;
}

only allow a specific value

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

Optional isAfter

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

only allow date strings after a specific date

Optional isAlpha

isAlpha?: boolean | {
    msg: string;
}

will only allow letters

Optional isAlphanumeric

isAlphanumeric?: boolean | {
    msg: string;
}

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

Optional isArray

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

only allow arrays

Optional isBefore

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

only allow date strings before a specific date

Optional isCreditCard

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

check for valid credit card numbers

Optional isDate

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

only allow date strings

Optional isDecimal

isDecimal?: boolean | {
    msg: string;
}

checks for any numbers

Optional isEmail

isEmail?: boolean | {
    msg: string;
}

checks for email format (foo@bar.com)

Optional isFloat

isFloat?: boolean | {
    msg: string;
}

checks for valid floating point numbers

Optional isIP

isIP?: boolean | {
    msg: string;
}

checks for IPv4 (129.89.23.1) or IPv6 format

Optional isIPv4

isIPv4?: boolean | {
    msg: string;
}

checks for IPv4 (129.89.23.1)

Optional isIPv6

isIPv6?: boolean | {
    msg: string;
}

checks for IPv6 format

Optional isIn

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

check the value is one of these

Optional isInt

isInt?: boolean | {
    msg: string;
}

checks for valid integers

Optional isLowercase

isLowercase?: boolean | {
    msg: string;
}

checks for lowercase

Optional isNull

isNull?: boolean | {
    msg: string;
}

only allows null

Optional isNumeric

isNumeric?: boolean | {
    msg: string;
}

will only allow numbers

Optional isUUID

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

only allow uuids

Optional isUppercase

isUppercase?: boolean | {
    msg: string;
}

checks for uppercase

Optional isUrl

isUrl?: boolean | {
    msg: string;
}

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

Optional len

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

only allow values with length between 2 and 10

Optional max

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

only allow values

Optional min

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

only allow values >= 23

Optional not

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

Optional notContains

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

don't allow specific substrings

Optional notEmpty

notEmpty?: boolean | {
    msg: string;
}

don't allow empty strings

Optional notIn

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

check the value is not one of these

Optional notNull

notNull?: boolean | {
    msg: string;
}

won't allow null

Settings

Member Visibility

Theme

Generated using TypeDoc