Installation 🤖

ESM-only. This package ships as native ESM ("type": "module") and must be loaded with import — require() is not supported. Requires Node.js >= 20.19 (or >= 22.12 / >= 24.15 / >= 26) and NestJS 12.

| @hodfords/nestjs-validation | NestJS | Node.js | Module system | | ----------------------------- | ------- | --------- | ------------- | | 12.x | 12.x | >=20.19 | ESM only | | 11.x | 11.x | >=18 | CommonJS |

Install the nestjs-validation package with:

npm install @hodfords/nestjs-validation --save

Usage 🚀

First, create an instance of ValidationPipe with the desired configuration:

import { ValidationPipe } from '@hodfords/nestjs-validation';
import { ValidateException } from '@hodfords/nestjs-exception';

export const validateConfig = new ValidationPipe({
    whitelist: true,
    stopAtFirstError: true,
    forbidUnknownValues: false,
    exceptionFactory: (errors): ValidateException => new ValidateException(errors)
});

Next, set the validation configuration globally in your bootstrap function:

async function bootstrap() {
    const app = await NestFactory.create(AppModule);
    app.useGlobalPipes(validateConfig);
    await app.listen(3000);
}

Customize Validation Error

The original error message provides basic information but lacks detail. With nestjs-validation, you can enhance these errors by adding meaningful context, such as the field’s property name, value, and target object.

Original Validation Error

ValidationError {
  target: AppDto { stringValue: undefined },
  value: undefined,
  property: 'stringValue',
  children: [],
  constraints: { isString: 'stringValue must be a string' }
}

Customized Validation Error

ValidationError {
  target: AppDto { stringValue: undefined },
  value: undefined,
  property: 'stringValue',
  children: [],
  constraints: {
    isString: {
      message: '$property must be a string',
      detail: { property: 'stringValue', target: 'AppDto', value: undefined }
    }
  }
}

Exception

When combined with nestjs-exception, errors are translated into localized messages:

{
    "message": "Validate Exception",
    "errors": {
        "stringValue": {
            "messages": ["String Value must be a string"]
        }
    }
}

NestJS 12 notes

• ValidationPipe overrides transform() entirely, so the new errorFormat: 'list' | 'grouped' option of the built-in NestJS 12 pipe has no effect here. Error shaping stays under your control through exceptionFactory (e.g. @hodfords/nestjs-exception's ValidateException).
• ArgumentMetadata is now generic (ArgumentMetadata<Metatype>) and carries an optional schema property. The default type argument is any, so existing pipes keep working unchanged.
• The new StandardSchemaValidationPipe and the schema option on @Body() / @Query() / @Param() are an alternative, Zod/Valibot-style validation path. They are unrelated to this package's class-validator based pipe and are not used here.

License 📝

This project is licensed under the MIT License