@decaf-ts/decorator-validation
Version:
simple decorator based validation engine
87 lines • 3.85 kB
JavaScript
;
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
return c > 3 && r && Object.defineProperty(target, key, r), r;
};
var __metadata = (this && this.__metadata) || function (k, v) {
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.EmailValidator = void 0;
const constants_1 = require("./constants.cjs");
const PatternValidator_1 = require("./PatternValidator.cjs");
const decorators_1 = require("./decorators.cjs");
/**
* @description Validator for checking if a string is a valid email address
* @summary The EmailValidator checks if a string matches a standard email address pattern.
* It extends the PatternValidator and uses a predefined email regex pattern to validate email addresses.
* This validator is typically used with the @email decorator.
*
* @param {string} [message] - Custom error message to display when validation fails, defaults to {@link DEFAULT_ERROR_MESSAGES#EMAIL}
*
* @class EmailValidator
* @extends PatternValidator
*
* @example
* ```typescript
* // Create an email validator with default error message
* const emailValidator = new EmailValidator();
*
* // Create an email validator with custom error message
* const customEmailValidator = new EmailValidator("Please enter a valid email address");
*
* // Validate an email
* const result = emailValidator.hasErrors("user@example.com"); // undefined (valid)
* const invalidResult = emailValidator.hasErrors("invalid-email"); // Returns error message (invalid)
* ```
*
* @mermaid
* sequenceDiagram
* participant C as Client
* participant E as EmailValidator
* participant P as PatternValidator
*
* C->>E: new EmailValidator(message)
* E->>P: super(message)
* C->>E: hasErrors(value, options)
* E->>P: super.hasErrors(value, options with EMAIL pattern)
* P-->>E: validation result
* E-->>C: validation result
*
* @category Validators
*/
let EmailValidator = class EmailValidator extends PatternValidator_1.PatternValidator {
constructor(message = constants_1.DEFAULT_ERROR_MESSAGES.EMAIL) {
super(message);
}
/**
* @description Checks if a string is a valid email address
* @summary Validates that the provided string matches the email pattern.
* This method extends the PatternValidator's hasErrors method by ensuring
* the email pattern is used, even if not explicitly provided in the options.
*
* @param {string} value - The string to validate as an email address
* @param {PatternValidatorOptions} [options={}] - Optional configuration options
*
* @return {string | undefined} Error message if validation fails, undefined if validation passes
*
* @override
*
* @see PatternValidator#hasErrors
*/
hasErrors(value, options = {}) {
return super.hasErrors(value, {
...options,
message: options.message || this.message,
pattern: options?.pattern || constants_1.DEFAULT_PATTERNS.EMAIL,
});
}
};
exports.EmailValidator = EmailValidator;
exports.EmailValidator = EmailValidator = __decorate([
(0, decorators_1.validator)(constants_1.ValidationKeys.EMAIL),
__metadata("design:paramtypes", [String])
], EmailValidator);
//# sourceMappingURL=EmailValidator.js.map