Validation مخصص
اكتب منطق validation مخصص باستخدام ValidatorConstraint classes وdecorators مخصصة عبر registerDecorator.
Custom Validation Classes
عمل Validator مخصص
import { ValidatorConstraint, ValidatorConstraintInterface, ValidationArguments } from 'class-validator';
@ValidatorConstraint({ name: 'customText', async: false })
export class CustomTextLength implements ValidatorConstraintInterface {
validate(text: string, args: ValidationArguments) {
return text.length > 1 && text.length < 10;
}
defaultMessage(args: ValidationArguments) {
return 'Text ($value) is too short or too long!';
}
}عملنا mark للـ class بـ decorator @ValidatorConstraint. تقدر كمان تحدد اسم للـ constraint —
الاسم ده هيستخدم كـ "error type" في الـ ValidationError. لو مش هتحدد اسم، هيتولد اسم تلقائي.
الـ class بتاعك لازم يعمل implement لـ interface اسمه ValidatorConstraintInterface ودالته
validate، اللي فيها منطق الـ validation. لو الـ validation نجح، الدالة بترجع true، وإلا
false. الـ validators المخصصة تقدر تكون async — لو عايز تعمل validation بعد عملية async، رجّع
Promise<boolean> من validate.
دالة defaultMessage (اختيارية) بتحدد رسالة خطأ افتراضية، بتستخدم لو الـ decorator نفسه مافيهوش
رسالة خطأ محددة.
استخدام الـ Validator المخصص
import { Validate } from 'class-validator';
import { CustomTextLength } from './CustomTextLength';
export class Post {
@Validate(CustomTextLength, {
message: 'Title is too short or long!'
})
title: string;
}تقدر كمان تمرر constraints للـ validator بتاعك:
import { Validate } from 'class-validator';
import { CustomTextLength } from './CustomTextLength';
export class Post {
@Validate(CustomTextLength, [3, 20], {
message: 'Wrong post title',
})
title: string;
}وتستخدمها من الـ object validationArguments:
import { ValidationArguments, ValidatorConstraint, ValidatorConstraintInterface } from 'class-validator';
@ValidatorConstraint()
export class CustomTextLength implements ValidatorConstraintInterface {
validate(text: string, validationArguments: ValidationArguments) {
return text.length > validationArguments.constraints[0] && text.length < validationArguments.constraints[1];
}
}Custom Validation Decorators
تقدر كمان تعمل decorator مخصص بنفسك. ده أنيق أوي في استخدام الـ validations المخصصة. خلينا نعمل
decorator اسمه @IsLongerThan:
عمل Decorator مخصص
import { registerDecorator, ValidationOptions, ValidationArguments } from 'class-validator';
export function IsLongerThan(property: string, validationOptions?: ValidationOptions) {
return function (object: Object, propertyName: string) {
registerDecorator({
name: 'isLongerThan',
target: object.constructor,
propertyName: propertyName,
constraints: [property],
options: validationOptions,
validator: {
validate(value: any, args: ValidationArguments) {
const [relatedPropertyName] = args.constraints;
const relatedValue = (args.object as any)[relatedPropertyName];
return typeof value === 'string' &&
typeof relatedValue === 'string' &&
value.length > relatedValue.length;
}
}
});
};
}استخدام الـ Decorator المخصص
import { IsLongerThan } from './IsLongerThan';
export class Post {
title: string;
@IsLongerThan('title', {
message: 'Text must be longer than the title'
})
text: string;
}تقدر كمان تستخدم ValidatorConstraint جوه الـ decorators المخصصة بتاعتك. خلينا نعمل decorator
تاني اسمه IsUserAlreadyExist:
import {
registerDecorator,
ValidationOptions,
ValidatorConstraint,
ValidatorConstraintInterface,
ValidationArguments,
} from 'class-validator';
@ValidatorConstraint({ async: true })
export class IsUserAlreadyExistConstraint implements ValidatorConstraintInterface {
validate(userName: any, args: ValidationArguments) {
return UserRepository.findOneByName(userName).then(user => {
if (user) return false;
return true;
});
}
}
export function IsUserAlreadyExist(validationOptions?: ValidationOptions) {
return function (object: Object, propertyName: string) {
registerDecorator({
target: object.constructor,
propertyName: propertyName,
options: validationOptions,
constraints: [],
validator: IsUserAlreadyExistConstraint,
});
};
}لاحظ إننا عملنا mark للـ constraint إنه async بإضافة { async: true } في options. وبعدين نستخدمه:
import { IsUserAlreadyExist } from './IsUserAlreadyExist';
export class User {
@IsUserAlreadyExist({
message: 'User $value already exists. Choose another name.',
})
name: string;
}🚀 محتاج توثيق زي ده لمنتجك؟
هذا الموقع بناه فريق Sonicar Tech LLC — بنساعد شركات SaaS وB2B والمؤسسات وFinTech وAI تطلق توثيق احترافي بأسلوب docs-as-code أسرع بـ 60% وأرخص، وأول نسخة جاهزة خلال أسبوع.
زيارة sonicar.tech ←