A set of constraint validation decorators inspired by JSR-303, JSR-349 and JSR-380.

• Introduction
• Getting Started
• Decorators
• Validation
  • Validator
  • Date Provider
• Development

The library makes it possible to:

• define constraints on properties
• define constraints on parameters
• define constraints on returned values

For a complete description, refer to the documentation.

A sample project is also available.

The modules can be installed using npm:

npm install @es-validation/decorators @es-validation/validator --save

Or using yarn:

yarn add @es-validation/decorators @es-validation/validator

A number of decorators are available, and can be used on properties, parameters or functions. In the later case, the constraint applies to the returned values.

¹ Strings are validated as base-10 numbers when the validator is configured with stringAsNumber (disabled by default)

² Strings are validated as ISO-8601 datetimes when the validator is configured with stringAsDate (disabled by default)

The @es-validation/validator module provides validation based on the @es-validation/decorators decorators.

The Validator class is used to perform constraint validation. The following validation methods are available:

The DateProvider interface is used to retrieve the current time, which is necessary for various decorators (@Past, @Future, etc.). It contains a single method:

There is generally no interaction with this interface from user code, unless new custom decorators dealing with time are defined. In this scenario, the DateProvider instance can be obtained through ConstraintValidationContext's getDateProvider() method.

The project requires lerna and yarn to be available globally.

Bootstrap the project:

yarn bootstrap

Build the project:

yarn build

Execute all tests:

yarn test