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

رسائل الـ Validation

تقدر تخصص رسائل الأخطاء في class-validator بنص ثابت، أو متغيرات زي $value و$constraint1، أو دوال ديناميكية.

تقدر تحدد رسالة الـ validation جوه options الـ decorator، والرسالة دي هترجع في الـ ValidationError اللي بترجع من دالة validate (لو الـ validation فشل).

الاستخدام الأساسي

import { MinLength, MaxLength } from 'class-validator';

export class Post {
    @MinLength(10, {
        message: 'Title is too short',
    })
    @MaxLength(50, {
        message: 'Title is too long',
    })
    title: string;
}

المتغيرات جوه الرسالة

فيه شوية tokens خاصة تقدر تستخدمها جوه الرسالة:

  • $value - القيمة اللي بتتعمل لها validation
  • $property - اسم الـ property بتاع الـ object اللي بتتعمل له validation
  • $target - اسم الـ class بتاع الـ object اللي بتتعمل له validation
  • $constraint1، $constraint2، ... $constraintN - القيود اللي محددها نوع الـ validation

مثال:

import { MinLength, MaxLength } from 'class-validator';

export class Post {
    @MinLength(10, {
        message: 'Title is too short. Minimal length is $constraint1 characters, but actual is $value',
    })
    @MaxLength(50, {
        message: 'Title is too long. Maximal length is $constraint1 characters, but actual is $value',
    })
    title: string;
}

رسائل ديناميكية

تقدر كمان تمرر دالة (function) بترجع الرسالة، وده بيخليك تعمل رسائل أدق:

import { MinLength, ValidationArguments } from 'class-validator';

export class Post {
    @MinLength(10, {
        message: (args: ValidationArguments) => {
            if (args.value.length === 1) {
                return 'Too short, minimum length is 1 character';
            } else {
                return 'Too short, minimum length is ' + args.constraints[0] + ' characters';
            }
        },
    })
    title: string;
}

الدالة بتاخد ValidationArguments اللي فيها:

  • value - القيمة اللي بتتعمل لها validation
  • constraints - array من القيود الخاصة بنوع الـ validation
  • targetName - اسم الـ class بتاع الـ object
  • object - الـ object اللي بتتعمل له validation
  • property - اسم الـ property اللي بتتعمل له validation

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

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

زيارة sonicar.tech ←

في هذه الصفحة