nest class-validator驗證修飾器中文文檔

驗證修飾器

通用驗證裝飾器

修飾器	描述（英文）	描述（中文）
@IsDefined(value: any)	Checks if value is defined (!== undefined, !== null). This is the only decorator that ignores skipMissingProperties option.	檢查是否定義了值 (!== undefined, !== null)。這是唯一忽略skipMissingProperties選項的裝飾程序
@IsOptional()	Checks if given value is empty (=== null, === undefined) and if so, ignores all the validators on the property.	檢查給定值是否為空(=== null, === undefined) ，如果是，則忽略屬性上的所有驗證程序
@Equals(comparison: any)	Checks if value equals ("===") comparison.	檢查值是否相等（“===”）比較
@NotEquals(comparison: any)	Checks if value not equal ("!==") comparison.	檢查值是否不相等（“!==”）比較
@IsEmpty()	Checks if given value is empty (=== ‘’, === null, === undefined).	檢查給定值是否為空(=== ‘’, === null, === undefined)
@IsNotEmpty()	Checks if given value is not empty (!== ‘’, !== null, !== undefined).	檢查給定值是否不為空 (!== ‘’, !== null, !== undefined)
@IsIn(values: any[])	Checks if value is in a array of allowed values.	檢查值是否在允許值的數組中
@IsNotIn(values: any[])	Checks if value is not in a array of disallowed values.	檢查值是否不在不允許的值數組中

類型驗證裝飾器

修飾器	描述（英文）	描述（中文）
@IsBoolean()	Checks if a value is a boolean.	是否為布爾值
@IsDate()	Checks if the value is a date.	是否為日期
@IsString()	Checks if the string is a string.	是否為字符串
@IsNumber(options: IsNumberOptions)	Checks if the value is a number.	是否為數字
@IsInt()	Checks if the value is an integer number.	是否為整數
@IsArray()	Checks if the value is an array	是否為數組
@IsEnum(entity: object)	Checks if the value is an valid enum	是否是有效的枚舉
Number validation decorators

數字驗證裝飾器

修飾器	描述（英文）	描述（中文）
@IsDivisibleBy(num: number)	Checks if the value is a number that’s divisible by another.	是否是可以被另一個數整除的數
@IsPositive()	Checks if the value is a positive number greater than zero.	是否是大於0的整數
@IsNegative()	Checks if the value is a negative number smaller than zero.	是否是小於0的整數
@Min(min: number)	Checks if the given number is greater than or equal to given number.	是否大於等於給定的數
@Max(max: number)	Checks if the given number is less than or equal to given number.	是否小於等於給定的數

日期驗證裝飾器

修飾器	描述（英文）	描述（中文）
@MinDate(date: Date)	Checks if the value is a date that’s after the specified date.	是否在指定日期之后
@MaxDate(date: Date)	Checks if the value is a date that’s before the specified date.	是否在指定日期之前

字符串類型驗證裝飾器

修飾器	描述（英文）	描述（中文）
@IsBooleanString()	Checks if a string is a boolean (e.g. is “true” or “false”).	是否為布爾值（例如“true”或“false”）
@IsDateString()	Alias for @IsISO8601().	@IsISO8601（）的別名
@IsNumberString(options?: IsNumericOptions)	Checks if a string is a number.	檢查字符串是否為數字

字符串驗證裝飾器

修飾器	描述（英文）	描述（中文）
@Contains(seed: string)	Checks if the string contains the seed.	是否包含種子
@NotContains(seed: string)	Checks if the string not contains the seed.	是否不包含種子
@IsAlpha()	Checks if the string contains only letters (a-zA-Z).	是否只包含字母
@IsAlphanumeric()	Checks if the string contains only letters and numbers.	是否只包含字母和數字
@IsDecimal(options?: IsDecimalOptions)	Checks if the string is a valid decimal value. Default IsDecimalOptions are force_decimal=False, decimal_digits: '1,', locale: 'en-US'	是否為有效的十進制值。默認的IsDecimalOptions是force_decimal=False，decimal_digits:‘1’，locale:‘en-US’
@IsAscii()	Checks if the string contains ASCII chars only.	是否只包含ASCII字符
@IsBase32()	Checks if a string is base32 encoded.	是否是base32編碼的
@IsBase64()	Checks if a string is base64 encoded.	是否是base64編碼的
@IsIBAN()	Checks if a string is a IBAN (International Bank Account Number).	是否為IBAN（國際銀行帳號）
@IsBIC()	Checks if a string is a BIC (Bank Identification Code) or SWIFT code.	是BIC（銀行識別碼）還是SWIFT碼
@IsByteLength(min: number, max?: number)	Checks if the string’s length (in bytes) falls in a range.	長度（以字節為單位）是否在某個范圍內
@IsCreditCard()	Checks if the string is a credit card.	是否為信用卡
@IsCurrency(options?: IsCurrencyOptions)	Checks if the string is a valid currency amount.	是否為有效的貨幣金額
@IsEthereumAddress()	Checks if the string is an Ethereum address using basic regex. Does not validate address checksums.	是否是以太坊地址。不驗證地址校驗和
@IsBtcAddress()	Checks if the string is a valid BTC address.	是否為有效的BTC地址
@IsDataURI()	Checks if the string is a data uri format.	是否為數據uri格式
@IsEmail(options?: IsEmailOptions)	Checks if the string is an email.	是否為電子郵件
@IsFQDN(options?: IsFQDNOptions)	Checks if the string is a fully qualified domain name (e.g. domain.com).	是否是完全限定的域名（例如domain.com）
@IsFullWidth()	Checks if the string contains any full-width chars.	是否包含任何全角字符
@IsHalfWidth()	Checks if the string contains any half-width chars.	是否包含任何半角字符
@IsVariableWidth()	Checks if the string contains a mixture of full and half-width chars.	是否包含全半角字符
@IsHexColor()	Checks if the string is a hexadecimal color.	是否為十六進制顏色
@IsHSLColor()	Checks if the string is an HSL color based on CSS Colors Level 4 specification.	是否是基於CSS Colors Level 4規范的HSL顏色
@IsRgbColor(options?: IsRgbOptions)	Checks if the string is a rgb or rgba color.	是rgb還是rgba顏色
@IsIdentityCard(locale?: string)	Checks if the string is a valid identity card code.	是否是有效的身份證代碼（估計是國外的身份證格式）
@IsPassportNumber(countryCode?: string)	Checks if the string is a valid passport number relative to a specific country code.	是否是相對於特定國家代碼的有效護照號碼
@IsPostalCode(locale?: string)	Checks if the string is a postal code.	是否是郵政編碼
@IsHexadecimal()	Checks if the string is a hexadecimal number.	是否為十六進制數
@IsOctal()	Checks if the string is a octal number.	是否為八進制數
@IsMACAddress(options?: IsMACAddressOptions)	Checks if the string is a MAC Address.	是否為MAC地址
@IsIP(version?: "4"\|"6")	Checks if the string is an IP (version 4 or 6).	是否為IP（版本4或6）
@IsPort()	Checks if the string is a valid port number.	是否為有效的端口號
@IsISBN(version?: "10"\|"13")	Checks if the string is an ISBN (version 10 or 13).	是否為ISBN（版本10或13）
@IsEAN()	Checks if the string is an if the string is an EAN (European Article Number).	是否為EAN（歐洲商品編號）
@IsISIN()	Checks if the string is an ISIN (stock/security identifier).	是否為ISIN（股票/安全標識符）
@IsISO8601(options?: IsISO8601Options)	Checks if the string is a valid ISO 8601 date format. Use the option strict = true for additional checks for a valid date.	是否為有效的ISO 8601日期格式。對於有效日期的其他檢查，請使用選項strict=true。
@IsJSON()	Checks if the string is valid JSON.	是否為有效的JSON
@IsJWT()	Checks if the string is valid JWT.	是否為有效的JWT
@IsObject()	Checks if the object is valid Object (null, functions, arrays will return false).	是否為有效對象（null、函數、數組將返回false）
@IsNotEmptyObject()	Checks if the object is not empty.	對象是否為空
@IsLowercase()	Checks if the string is lowercase.	是否為小寫
@IsLatLong()	Checks if the string is a valid latitude-longitude coordinate in the format lat, long.	是否為lat，long格式的有效經緯度坐標
@IsLatitude()	Checks if the string or number is a valid latitude coordinate.	檢查字符串或數字是否是有效的緯度坐標
@IsLongitude()	Checks if the string or number is a valid longitude coordinate.	檢查字符串或數字是否為有效的經度坐標
@IsMobilePhone(locale: string)	Checks if the string is a mobile phone number.	是否是移動電話號碼
@IsISO31661Alpha2()	Checks if the string is a valid ISO 3166-1 alpha-2 officially assigned country code.	是否是有效的iso3166-1alpha-2官方指定的國家代碼。
@IsISO31661Alpha3()	Checks if the string is a valid ISO 3166-1 alpha-3 officially assigned country code.	是否是有效的iso3166-1alpha-3官方指定的國家代碼。
@IsLocale()	Checks if the string is a locale.	是否為區域設置
@IsPhoneNumber(region: string)	Checks if the string is a valid phone numberusing libphonenumber-js.	是否是有效的電話號碼
@IsMongoId()	Checks if the string is a valid hex-encoded representation of a MongoDB ObjectId.	是否是MongoDB ObjectId的有效十六進制編碼表示形式
@IsMultibyte()	Checks if the string contains one or more multibyte chars.	是否包含一個或多個多字節字符
@IsNumberString(options?: IsNumericOptions)	Checks if the string is numeric.	是否包含任何代理項對字符
@IsSurrogatePair()	Checks if the string contains any surrogate pairs chars.	是否包含任何代理項對字符
@IsUrl(options?: IsURLOptions)	Checks if the string is an url.	是否為url
@IsMagnetURI()	Checks if the string is a magnet uri format.	是否為magneturi格式
@IsUUID(version?: "3"\|"4"\|"5"\|"all")	Checks if the string is a UUID (version 3, 4, 5 or all ).	是否是UUID（version 3、4、5或all）
@IsFirebasePushId()	Checks if the string is a Firebase Push ID	是否為Firebase Push ID
@IsUppercase()	Checks if the string is uppercase.	是否為大寫
@Length(min: number, max?: number)	Checks if the string’s length falls in a range.	符串的長度是否在某個范圍內
@MinLength(min: number)	Checks if the string’s length is not less than given number.	字符串的長度是否不小於給定的數字
@MaxLength(max: number)	Checks if the string’s length is not more than given number.	字符串的長度是否不大於給定的數字
@Matches(pattern: RegExp, modifiers?: string)	Checks if string matches the pattern. Either matches(‘foo’, /foo/i) or matches(‘foo’, ‘foo’, ‘i’).	是否與模式匹配，匹配（‘foo’，/foo/i）或匹配（‘foo’，‘foo’，‘i’）
@IsMilitaryTime()	Checks if the string is a valid representation of military time in the format HH:MM.	是否是HH:MM格式的有效軍事時間表示形式
@IsHash(algorithm: string)	Checks if the string is a hash The following types are supported:md4, md5, sha1, sha256, sha384, sha512, ripemd128, ripemd160, tiger128, tiger160, tiger192, crc32, crc32b.	是否是散列，以下類型是supported:md4、md5、sha1、sha256、sha384、sha512、ripemd128、ripemd160、tiger128、tiger128、tiger192、crc32、crc32b。
@IsMimeType()	Checks if the string matches to a valid MIME type format	是否與有效的MIME類型格式匹配
@IsSemVer()	Checks if the string is a Semantic Versioning Specification (SemVer).	是否為語義版本控制規范（SemVer）
@IsISSN(options?: IsISSNOptions)	Checks if the string is a ISSN.	是否為ISSN
@IsISRC()	Checks if the string is a ISRC.	是否為ISRC
@IsRFC3339()	Checks if the string is a valid RFC 3339 date.	是否為有效的RFC 3339日期

數組驗證裝飾器

修飾器	描述（英文）	描述（中文）
@ArrayContains(values: any[])	Checks if array contains all values from the given array of values.	是否包含給定值數組中的所有值
@ArrayNotContains(values: any[])	Checks if array does not contain any of the given values.	是否不包含任何給定值
@ArrayNotEmpty()	Checks if given array is not empty.	是否為空
@ArrayMinSize(min: number)	Checks if the array’s length is greater than or equal to the specified number.	數組的長度是否大於或等於指定的數字
@ArrayMaxSize(max: number)	Checks if the array’s length is less or equal to the specified number.	數組的長度是否小於或等於指定的數字
@ArrayUnique(identifier?: (o) => any)	Checks if all array’s values are unique. Comparison for objects is reference-based. Optional function can be speciefied which return value will be used for the comparsion.	所有數組的值是否唯一。對象的比較是基於引用的。可選函數可以指定用於比較的返回值

對象驗證裝飾器

修飾器	描述（英文）	描述（中文）
@IsInstance(value: any)	Checks if the property is an instance of the passed value.	屬性是否是傳遞值的實例

其他驗證裝飾器

修飾器	描述（英文）	描述（中文）
@Allow()	Prevent stripping off the property when no other constraint is specified for it.	防止在沒有為屬性指定其他約束時剝離該屬性