@nest-boot/validator

Interfaces

ArrayLengthOptions

Defined in: packages/validator/src/decorators/common/array-length.decorator.ts:4

Extends

• ValidationOptions

Properties

always?

optional always: boolean;

Defined in: node_modules/.pnpm/class-validator@0.14.3/node_modules/class-validator/types/decorator/ValidationOptions.d.ts:22

Indicates if validation must be performed always, no matter of validation groups used.

Inherited from

ValidationOptions.always

context?

optional context: any;

Defined in: node_modules/.pnpm/class-validator@0.14.3/node_modules/class-validator/types/decorator/ValidationOptions.d.ts:23

Inherited from

ValidationOptions.context

each?

optional each: boolean;

Defined in: node_modules/.pnpm/class-validator@0.14.3/node_modules/class-validator/types/decorator/ValidationOptions.d.ts:9

Specifies if validated value is an array and each of its items must be validated.

Inherited from

ValidationOptions.each

groups?

optional groups: string[];

Defined in: node_modules/.pnpm/class-validator@0.14.3/node_modules/class-validator/types/decorator/ValidationOptions.d.ts:18

Validation groups used for this validation.

Inherited from

ValidationOptions.groups

max?

optional max: number;

Defined in: packages/validator/src/decorators/common/array-length.decorator.ts:6

message?

optional message: string | (validationArguments) => string;

Defined in: node_modules/.pnpm/class-validator@0.14.3/node_modules/class-validator/types/decorator/ValidationOptions.d.ts:14

Error message to be used on validation fail. Message can be either string or a function that returns a string.

Inherited from

ValidationOptions.message

min?

optional min: number;

Defined in: packages/validator/src/decorators/common/array-length.decorator.ts:5

Variables

IS_DATE

const IS_DATE: "isDate" = "isDate";

Defined in: packages/validator/src/decorators/type-check/is-date.decorator.ts:5

---

IS_EMAIL

const IS_EMAIL: "isEmail" = "isEmail";

Defined in: packages/validator/src/decorators/string/is-email.decorator.ts:7

---

IS_LENGTH

const IS_LENGTH: "isLength" = "isLength";

Defined in: packages/validator/src/decorators/string/length.decorator.ts:6

---

IS_NUMBER_STRING

const IS_NUMBER_STRING: "isNumberString" = "isNumberString";

Defined in: packages/validator/src/decorators/string/is-number-string.decorator.ts:7

---

IS_URL

const IS_URL: "isUrl" = "isUrl";

Defined in: packages/validator/src/decorators/string/is-url.decorator.ts:7

Functions

ArrayLength()

function ArrayLength(validationOptions): PropertyDecorator;

Defined in: packages/validator/src/decorators/common/array-length.decorator.ts:47

Parameters

Parameter	Type
validationOptions	ArrayLengthOptions

Returns

PropertyDecorator

---

buildI18nMessage()

function buildI18nMessage(callback): (args) => string;

Defined in: packages/validator/src/utils/build-i18n-message.ts:4

Parameters

Parameter	Type
callback	(args) => string

Returns

(args): string;

Parameters

Parameter	Type
args	ValidationArguments

Returns

string

---

isDate()

function isDate(value): boolean;

Defined in: packages/validator/src/decorators/type-check/is-date.decorator.ts:10

Checks if a given value is a date.

Parameters

Parameter	Type
value	unknown

Returns

boolean

---

IsDate()

function IsDate(validationOptions?): PropertyDecorator;

Defined in: packages/validator/src/decorators/type-check/is-date.decorator.ts:17

Checks if a value is a date.

Parameters

Parameter	Type
validationOptions?	ValidationOptions

Returns

PropertyDecorator

---

IsDomain()

function IsDomain(validationOptions?): PropertyDecorator;

Defined in: packages/validator/src/decorators/string/is-domain.decorator.ts:5

Parameters

Parameter	Type
validationOptions?	ValidationOptions

Returns

PropertyDecorator

---

isEmail()

function isEmail(value, options?): boolean;

Defined in: packages/validator/src/decorators/string/is-email.decorator.ts:13

Checks if the string is an email. If given value is not a string, then it returns false.

Parameters

Parameter	Type
value	unknown
options?	IsEmailOptions

Returns

boolean

---

IsEmail()

function IsEmail(options?, validationOptions?): PropertyDecorator;

Defined in: packages/validator/src/decorators/string/is-email.decorator.ts:21

Checks if the string is an email. If given value is not a string, then it returns false.

Parameters

Parameter	Type
options?	IsEmailOptions
validationOptions?	ValidationOptions

Returns

PropertyDecorator

---

IsGreaterThan()

function IsGreaterThan(field, validationOptions?): PropertyDecorator;

Defined in: packages/validator/src/decorators/number/is-greater-than.decorator.ts:8

Parameters

Parameter	Type
field	string
validationOptions?	ValidationOptions

Returns

PropertyDecorator

---

IsGreaterThanOrEqual()

function IsGreaterThanOrEqual(field, validationOptions?): PropertyDecorator;

Defined in: packages/validator/src/decorators/number/is-greater-than-or-equal.decorator.ts:8

Parameters

Parameter	Type
field	string
validationOptions?	ValidationOptions

Returns

PropertyDecorator

---

IsLessThan()

function IsLessThan(field, validationOptions?): PropertyDecorator;

Defined in: packages/validator/src/decorators/number/is-less-than.decorator.ts:8

Parameters

Parameter	Type
field	string
validationOptions?	ValidationOptions

Returns

PropertyDecorator

---

IsLessThanOrEqual()

function IsLessThanOrEqual(field, validationOptions?): PropertyDecorator;

Defined in: packages/validator/src/decorators/number/is-less-than-or-equal.decorator.ts:8

Parameters

Parameter	Type
field	string
validationOptions?	ValidationOptions

Returns

PropertyDecorator

---

isNumberString()

function isNumberString(value, options?): boolean;

Defined in: packages/validator/src/decorators/string/is-number-string.decorator.ts:13

Checks if the string is numeric. If given value is not a string, then it returns false.

Parameters

Parameter	Type
value	unknown
options?	IsNumericOptions

Returns

boolean

---

IsNumberString()

function IsNumberString(options?, validationOptions?): PropertyDecorator;

Defined in: packages/validator/src/decorators/string/is-number-string.decorator.ts:24

Checks if the string is numeric. If given value is not a string, then it returns false.

Parameters

Parameter	Type
options?	IsNumericOptions
validationOptions?	ValidationOptions

Returns

PropertyDecorator

---

IsOptional()

function IsOptional(validationOptions?): PropertyDecorator;

Defined in: node_modules/.pnpm/class-validator@0.14.3/node_modules/class-validator/types/decorator/common/IsOptional.d.ts:6

Checks if value is missing and if so, ignores all validators.

Parameters

Parameter	Type
validationOptions?	ValidationOptions

Returns

PropertyDecorator

---

IsTimezone()

function IsTimezone(validationOptions?): PropertyDecorator;

Defined in: packages/validator/src/decorators/string/is-timezone.decorator.ts:6

Parameters

Parameter	Type
validationOptions?	ValidationOptions

Returns

PropertyDecorator

---

isURL()

function isURL(value, options?): boolean;

Defined in: packages/validator/src/decorators/string/is-url.decorator.ts:13

Checks if the string is an url. If given value is not a string, then it returns false.

Parameters

Parameter	Type
value	string
options?	IsURLOptions

Returns

boolean

---

IsUrl()

function IsUrl(options?, validationOptions?): PropertyDecorator;

Defined in: packages/validator/src/decorators/string/is-url.decorator.ts:21

Checks if the string is an url. If given value is not a string, then it returns false.

Parameters

Parameter	Type
options?	IsURLOptions
validationOptions?	ValidationOptions

Returns

PropertyDecorator

---

length()

function length(
   value, 
   min, 
   max?): boolean;

Defined in: packages/validator/src/decorators/string/length.decorator.ts:12

Checks if the string's length falls in a range. Note: this function takes into account surrogate pairs. If given value is not a string, then it returns false.

Parameters

Parameter	Type
value	unknown
min	number
max?	number

Returns

boolean

---

Length()

function Length(
   min, 
   max?, 
   validationOptions?): PropertyDecorator;

Defined in: packages/validator/src/decorators/string/length.decorator.ts:20

Checks if the string's length falls in a range. Note: this function takes into account surrogate pairs. If given value is not a string, then it returns false.

Parameters

Parameter	Type
min	number
max?	number
validationOptions?	ValidationOptions

Returns

PropertyDecorator

---

Max()

function Max(maxValue, validationOptions?): PropertyDecorator;

Defined in: packages/validator/src/decorators/number/max.decorator.ts:5

Parameters

Parameter	Type
maxValue	number
validationOptions?	ValidationOptions

Returns

PropertyDecorator

---

Min()

function Min(minValue, validationOptions?): PropertyDecorator;

Defined in: packages/validator/src/decorators/number/min.decorator.ts:5

Parameters

Parameter	Type
minValue	number
validationOptions?	ValidationOptions

Returns

PropertyDecorator

---

ValidateNested()

function ValidateNested(validationOptions?): PropertyDecorator;

Defined in: node_modules/.pnpm/class-validator@0.14.3/node_modules/class-validator/types/decorator/common/ValidateNested.d.ts:5

Objects / object arrays marked with this decorator will also be validated.

Parameters

Parameter	Type
validationOptions?	ValidationOptions

Returns

PropertyDecorator