🚀 توثيق مصمّم بواسطة Sonicar Tech LLC — احصل على توثيق منتجك خلال أسبوع ←
توثيق Class Validator من Sonicar.Tech
مرجع الـ API

مرجع Decorators الـ Validation

مرجع كامل لكل الـ decorators الجاهزة في class-validator، مقسمة على فئات (common، type، number، date، string، array، object).

القائمة الكاملة للـ decorators اللي جايه مع class-validator، مقسمة على فئات.

Decorators أساسية (Common)

Decoratorالوصف
@IsDefined(value: any)يتأكد إن القيمة معرّفة (!== undefined، !== null). ده الـ decorator الوحيد اللي بيتجاهل skipMissingProperties.
@IsOptional()يتأكد لو القيمة فاضية (=== null، === undefined)، ولو كده يتجاهل كل الـ validators على الـ property.
@Equals(comparison: any)يتأكد إن القيمة بتساوي (===) القيمة اللي مررتها.
@NotEquals(comparison: any)يتأكد إن القيمة مش بتساوي (!==) القيمة اللي مررتها.
@IsEmpty()يتأكد إن القيمة فاضية (=== ''، === null، === undefined).
@IsNotEmpty()يتأكد إن القيمة مش فاضية (!== ''، !== null، !== undefined).
@IsIn(values: any[])يتأكد إن القيمة موجودة جوه array من القيم المسموح بيها.
@IsNotIn(values: any[])يتأكد إن القيمة مش موجودة جوه array من القيم الممنوعة.

Decorators الأنواع (Type)

Decoratorالوصف
@IsBoolean()يتأكد إن القيمة boolean.
@IsDate()يتأكد إن القيمة تاريخ.
@IsString()يتأكد إن القيمة string.
@IsNumber(options: IsNumberOptions)يتأكد إن القيمة رقم.
@IsInt()يتأكد إن القيمة عدد صحيح.
@IsArray()يتأكد إن القيمة array.
@IsEnum(entity: object)يتأكد إن القيمة enum صحيح.

Decorators الأرقام (Number)

Decoratorالوصف
@IsDivisibleBy(num: number)يتأكد إن الرقم قابل للقسمة على رقم تاني.
@IsPositive()يتأكد إن الرقم موجب وأكبر من صفر.
@IsNegative()يتأكد إن الرقم سالب وأصغر من صفر.
@Min(min: number)يتأكد إن الرقم أكبر من أو يساوي الرقم اللي مررته.
@Max(max: number)يتأكد إن الرقم أصغر من أو يساوي الرقم اللي مررته.

Decorators التواريخ (Date)

Decoratorالوصف
@MinDate(date: Date | (() => Date))يتأكد إن التاريخ بعد التاريخ المحدد.
@MaxDate(date: Date | (() => Date))يتأكد إن التاريخ قبل التاريخ المحدد.

Decorators من نوع String خاصة

Decoratorالوصف
@IsBooleanString()يتأكد إن الـ string قيمته boolean (زي "true" أو "false" أو "1" أو "0").
@IsDateString()اسم بديل لـ @IsISO8601().
@IsNumberString(options?: IsNumericOptions)يتأكد إن الـ string رقم.

Decorators النصوص (String)

Decoratorالوصف
@Contains(seed: string)يتأكد إن الـ string فيه النص اللي مررته.
@NotContains(seed: string)يتأكد إن الـ string مفيهوش النص اللي مررته.
@IsAlpha()يتأكد إن الـ string فيه حروف بس (a-zA-Z).
@IsAlphanumeric()يتأكد إن الـ string فيه حروف وأرقام بس.
@IsDecimal(options?: IsDecimalOptions)يتأكد إن الـ string قيمة عشرية صحيحة. القيم الافتراضية: force_decimal=False، decimal_digits: '1,'، locale: 'en-US'.
@IsAscii()يتأكد إن الـ string فيه حروف ASCII بس.
@IsBase32()يتأكد إن الـ string مشفر بـ base32.
@IsBase58()يتأكد إن الـ string مشفر بـ base58.
@IsBase64(options?: IsBase64Options)يتأكد إن الـ string مشفر بـ base64.
@IsIBAN()يتأكد إن الـ string رقم IBAN صحيح.
@IsBIC()يتأكد إن الـ string كود BIC أو SWIFT صحيح.
@IsByteLength(min: number, max?: number)يتأكد إن طول الـ string (بالبايت) في النطاق المحدد.
@IsCreditCard()يتأكد إن الـ string رقم كارت ائتمان صحيح.
@IsCurrency(options?: IsCurrencyOptions)يتأكد إن الـ string قيمة عملة صحيحة.
@IsISO4217CurrencyCode()يتأكد إن الـ string كود عملة ISO 4217 صحيح.
@IsEthereumAddress()يتأكد إن الـ string عنوان Ethereum (باستخدام regex بسيط، من غير التحقق من الـ checksum).
@IsBtcAddress()يتأكد إن الـ string عنوان BTC صحيح.
@IsDataURI()يتأكد إن الـ string بصيغة data URI.
@IsEmail(options?: IsEmailOptions)يتأكد إن الـ string إيميل صحيح.
@IsFQDN(options?: IsFQDNOptions)يتأكد إن الـ string اسم دومين صحيح (زي domain.com).
@IsFullWidth()يتأكد إن الـ string فيه full-width characters.
@IsHalfWidth()يتأكد إن الـ string فيه half-width characters.
@IsVariableWidth()يتأكد إن الـ string فيه full وhalf width مع بعض.
@IsHexColor()يتأكد إن الـ string لون hexadecimal.
@IsHSL()يتأكد إن الـ string لون HSL حسب CSS Colors Level 4.
@IsRgbColor(options?: IsRgbOptions)يتأكد إن الـ string لون rgb أو rgba.
@IsIdentityCard(locale?: string)يتأكد إن الـ string كود بطاقة هوية صحيح.
@IsPassportNumber(countryCode?: string)يتأكد إن الـ string رقم جواز سفر صحيح لدولة معينة.
@IsPostalCode(locale?: string)يتأكد إن الـ string رمز بريدي صحيح.
@IsHexadecimal()يتأكد إن الـ string رقم hexadecimal.
@IsOctal()يتأكد إن الـ string رقم octal.
@IsMACAddress(options?: IsMACAddressOptions)يتأكد إن الـ string عنوان MAC صحيح.
@IsIP(version?: "4"|"6")يتأكد إن الـ string عنوان IP (نسخة 4 أو 6).
@IsPort()يتأكد إن الـ string رقم port صحيح.
@IsISBN(version?: "10"|"13")يتأكد إن الـ string رقم ISBN (نسخة 10 أو 13).
@IsEAN()يتأكد إن الـ string رقم EAN صحيح.
@IsISIN()يتأكد إن الـ string كود ISIN صحيح.
@IsISO8601(options?: IsISO8601Options)يتأكد إن الـ string تاريخ بصيغة ISO 8601 صحيحة. استخدم strict = true لفحص أدق.
@IsJSON()يتأكد إن الـ string بصيغة JSON صحيحة.
@IsJWT()يتأكد إن الـ string توكن JWT صحيح.
@IsObject()يتأكد إن القيمة Object صحيح (بيرفض null والـ functions والـ arrays).
@IsNotEmptyObject()يتأكد إن الـ object مش فاضي.
@IsLowercase()يتأكد إن الـ string كله حروف صغيرة.
@IsLatLong()يتأكد إن الـ string إحداثيات lat/long صحيحة بصيغة lat, long.
@IsLatitude()يتأكد إن القيمة (string أو number) خط عرض صحيح.
@IsLongitude()يتأكد إن القيمة (string أو number) خط طول صحيح.
@IsMobilePhone(locale: string)يتأكد إن الـ string رقم موبايل صحيح.
@IsISO6391()يتأكد إن الـ string كود لغة ISO 639-1 صحيح.
@IsISO31661Alpha2()يتأكد إن الـ string كود دولة ISO 3166-1 alpha-2 صحيح.
@IsISO31661Alpha3()يتأكد إن الـ string كود دولة ISO 3166-1 alpha-3 صحيح.
@IsISO31661Numeric()يتأكد إن الـ string كود دولة ISO 3166-1 رقمي صحيح.
@IsLocale()يتأكد إن الـ string locale صحيح.
@IsPhoneNumber(region: string)يتأكد إن الـ string رقم تليفون صحيح باستخدام libphonenumber-js.
@IsMongoId()يتأكد إن الـ string ObjectId صحيح لـ MongoDB (hex-encoded).
@IsMultibyte()يتأكد إن الـ string فيه حرف واحد على الأقل multibyte.
@IsNumberString(options?: IsNumericOptions)يتأكد إن الـ string رقمي.
@IsSurrogatePair()يتأكد إن الـ string فيه surrogate pairs.
@IsTaxId()يتأكد إن الـ string رقم ضريبي صحيح. الـ locale الافتراضي en-US.
@IsUrl(options?: IsURLOptions)يتأكد إن الـ string رابط URL صحيح.
@IsMagnetURI()يتأكد إن الـ string بصيغة magnet uri.
@IsUUID(version?: UUIDVersion)يتأكد إن الـ string UUID صحيح (نسخة 1-8، nil، max، loose، all). ممكن كمان تمرر array نسخ.
@IsFirebasePushId()يتأكد إن الـ string Firebase Push ID صحيح.
@IsUppercase()يتأكد إن الـ string كله حروف كبيرة.
@Length(min: number, max?: number)يتأكد إن طول الـ string في النطاق المحدد.
@MinLength(min: number)يتأكد إن طول الـ string مش أقل من الرقم المحدد.
@MaxLength(max: number)يتأكد إن طول الـ string مش أكتر من الرقم المحدد.
@Matches(pattern: RegExp, modifiers?: string)يتأكد إن الـ string بيطابق الـ pattern. زي matches('foo', /foo/i) أو matches('foo', 'foo', 'i').
@IsMilitaryTime()يتأكد إن الـ string وقت عسكري صحيح بصيغة HH:MM.
@IsTimeZone()يتأكد إن الـ string منطقة زمنية IANA صحيحة.
@IsHash(algorithm: string)يتأكد إن الـ string hash صحيح. الأنواع المدعومة: md4، md5، sha1، sha256، sha384، sha512، ripemd128، ripemd160، tiger128، tiger160، tiger192، crc32، crc32b.
@IsMimeType()يتأكد إن الـ string بصيغة MIME type صحيحة.
@IsSemVer()يتأكد إن الـ string بصيغة Semantic Versioning صحيحة.
@IsISSN(options?: IsISSNOptions)يتأكد إن الـ string رقم ISSN صحيح.
@IsISRC()يتأكد إن الـ string كود ISRC صحيح.
@IsRFC3339()يتأكد إن الـ string تاريخ بصيغة RFC 3339 صحيحة.
@IsStrongPassword(options?: IsStrongPasswordOptions)يتأكد إن الـ string باسورد قوي.

Decorators الـ Arrays

Decoratorالوصف
@ArrayContains(values: any[])يتأكد إن الـ array فيه كل القيم اللي مررتها.
@ArrayNotContains(values: any[])يتأكد إن الـ array مافيهوش أي من القيم اللي مررتها.
@ArrayNotEmpty()يتأكد إن الـ array مش فاضي.
@ArrayMinSize(min: number)يتأكد إن طول الـ array أكبر من أو يساوي الرقم المحدد.
@ArrayMaxSize(max: number)يتأكد إن طول الـ array أصغر من أو يساوي الرقم المحدد.
@ArrayUnique(identifier?: (o) => any)يتأكد إن كل قيم الـ array فريدة (المقارنة للـ objects بتكون بالـ reference). ممكن تمرر دالة تحدد القيمة اللي هتتقارن بيها.

Decorators الخاصة بالـ Objects

Decoratorالوصف
@IsInstance(value: any)يتأكد إن الـ property instance من الـ class اللي مررته.

Decorators تانية

Decoratorالوصف
@Allow()يمنع مسح الـ property لو مافيهاش أي decorator تاني.

🚀 محتاج توثيق زي ده لمنتجك؟

هذا الموقع بناه فريق Sonicar Tech LLC — بنساعد شركات SaaS وB2B والمؤسسات وFinTech وAI تطلق توثيق احترافي بأسلوب docs-as-code أسرع بـ 60% وأرخص، وأول نسخة جاهزة خلال أسبوع.

زيارة sonicar.tech ←