@decaf-ts/decorator-validation
Version:
simple decorator based validation engine
53 lines • 6.15 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.Validator = void 0;
const constants_1 = require("./constants.cjs");
const BaseValidator_1 = require("./BaseValidator.cjs");
/**
* @description
* Abstract class for defining synchronous validators.
*
* This class extends the base {@link BaseValidator} and enforces that any implementation of `hasErrors` must be synchronous.
*
* Use this when the validation process is immediate and does not require asynchronous operations.
*
* @example
* ```typescript
* // Example of a synchronous validator that checks if a number is greater than
* class GreaterThanValidator extends Validator<{ gt?: number }> {
* constructor(message: string = "Value must be greater than {0}") {
* super(message);
* }
*
* hasErrors(value: number, options?: { gt?: number }) {
* const minValue = options?.gt ?? 0;
* if (value <= minValue) {
* return this.getMessage();
* }
* return undefined;
* }
* }
*
* // Example usage:
* const validator = new GreaterThanValidator();
* const error = validator.hasErrors(10, { gt: 15 });
* if (error) {
* console.log('Value must be greater than 15')
* } else {
* console.log('Value is valid');
* }
* ```
*
* - If `value` is less than or equal to `gt`, returns the error message.
* - Otherwise, returns `undefined` indicating validation success.
*
* @see {@link BaseValidator} For the base validator.
* @see {@link ValidatorOptions} For the base validator options.
*/
class Validator extends BaseValidator_1.BaseValidator {
constructor(message = constants_1.DEFAULT_ERROR_MESSAGES.DEFAULT, ...acceptedTypes) {
super(false, message, ...acceptedTypes);
}
}
exports.Validator = Validator;
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVmFsaWRhdG9yLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3ZhbGlkYXRpb24vVmFsaWRhdG9ycy9WYWxpZGF0b3IudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsK0NBQXFEO0FBR3JELHVEQUFnRDtBQUVoRDs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQXdDRztBQUNILE1BQXNCLFNBRXBCLFNBQVEsNkJBQXVCO0lBQy9CLFlBQ0UsVUFBa0Isa0NBQXNCLENBQUMsT0FBTyxFQUNoRCxHQUFHLGFBQXVCO1FBRTFCLEtBQUssQ0FBQyxLQUFLLEVBQUUsT0FBTyxFQUFFLEdBQUcsYUFBYSxDQUFDLENBQUM7SUFDMUMsQ0FBQztDQXdCRjtBQWhDRCw4QkFnQ0MiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBERUZBVUxUX0VSUk9SX01FU1NBR0VTIH0gZnJvbSBcIi4vY29uc3RhbnRzXCI7XG5pbXBvcnQgeyBWYWxpZGF0b3JPcHRpb25zIH0gZnJvbSBcIi4uL3R5cGVzXCI7XG5pbXBvcnQgdHlwZSB7IFBhdGhQcm94eSB9IGZyb20gXCIuLi8uLi91dGlsc1wiO1xuaW1wb3J0IHsgQmFzZVZhbGlkYXRvciB9IGZyb20gXCIuL0Jhc2VWYWxpZGF0b3JcIjtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb25cbiAqIEFic3RyYWN0IGNsYXNzIGZvciBkZWZpbmluZyBzeW5jaHJvbm91cyB2YWxpZGF0b3JzLlxuICpcbiAqIFRoaXMgY2xhc3MgZXh0ZW5kcyB0aGUgYmFzZSB7QGxpbmsgQmFzZVZhbGlkYXRvcn0gYW5kIGVuZm9yY2VzIHRoYXQgYW55IGltcGxlbWVudGF0aW9uIG9mIGBoYXNFcnJvcnNgIG11c3QgYmUgc3luY2hyb25vdXMuXG4gKlxuICogVXNlIHRoaXMgd2hlbiB0aGUgdmFsaWRhdGlvbiBwcm9jZXNzIGlzIGltbWVkaWF0ZSBhbmQgZG9lcyBub3QgcmVxdWlyZSBhc3luY2hyb25vdXMgb3BlcmF0aW9ucy5cbiAqXG4gKiBAZXhhbXBsZVxuICogYGBgdHlwZXNjcmlwdFxuICogLy8gRXhhbXBsZSBvZiBhIHN5bmNocm9ub3VzIHZhbGlkYXRvciB0aGF0IGNoZWNrcyBpZiBhIG51bWJlciBpcyBncmVhdGVyIHRoYW5cbiAqIGNsYXNzIEdyZWF0ZXJUaGFuVmFsaWRhdG9yIGV4dGVuZHMgVmFsaWRhdG9yPHsgZ3Q/OiBudW1iZXIgfT4ge1xuICogICBjb25zdHJ1Y3RvcihtZXNzYWdlOiBzdHJpbmcgPSBcIlZhbHVlIG11c3QgYmUgZ3JlYXRlciB0aGFuIHswfVwiKSB7XG4gKiAgICAgc3VwZXIobWVzc2FnZSk7XG4gKiAgIH1cbiAqXG4gKiAgIGhhc0Vycm9ycyh2YWx1ZTogbnVtYmVyLCBvcHRpb25zPzogeyBndD86IG51bWJlciB9KSB7XG4gKiAgICAgY29uc3QgbWluVmFsdWUgPSBvcHRpb25zPy5ndCA/PyAwO1xuICogICAgIGlmICh2YWx1ZSA8PSBtaW5WYWx1ZSkge1xuICogICAgICAgcmV0dXJuIHRoaXMuZ2V0TWVzc2FnZSgpO1xuICogICAgIH1cbiAqICAgICByZXR1cm4gdW5kZWZpbmVkO1xuICogICB9XG4gKiB9XG4gKlxuICogLy8gRXhhbXBsZSB1c2FnZTpcbiAqIGNvbnN0IHZhbGlkYXRvciA9IG5ldyBHcmVhdGVyVGhhblZhbGlkYXRvcigpO1xuICogY29uc3QgZXJyb3IgPSB2YWxpZGF0b3IuaGFzRXJyb3JzKDEwLCB7IGd0OiAxNSB9KTtcbiAqIGlmIChlcnJvcikge1xuICogICBjb25zb2xlLmxvZygnVmFsdWUgbXVzdCBiZSBncmVhdGVyIHRoYW4gMTUnKVxuICogfSBlbHNlIHtcbiAqICAgY29uc29sZS5sb2coJ1ZhbHVlIGlzIHZhbGlkJyk7XG4gKiB9XG4gKiBgYGBcbiAqXG4gKiAtIElmIGB2YWx1ZWAgaXMgbGVzcyB0aGFuIG9yIGVxdWFsIHRvIGBndGAsIHJldHVybnMgdGhlIGVycm9yIG1lc3NhZ2UuXG4gKiAtIE90aGVyd2lzZSwgcmV0dXJucyBgdW5kZWZpbmVkYCBpbmRpY2F0aW5nIHZhbGlkYXRpb24gc3VjY2Vzcy5cbiAqXG4gKiBAc2VlIHtAbGluayBCYXNlVmFsaWRhdG9yfSBGb3IgdGhlIGJhc2UgdmFsaWRhdG9yLlxuICogQHNlZSB7QGxpbmsgVmFsaWRhdG9yT3B0aW9uc30gRm9yIHRoZSBiYXNlIHZhbGlkYXRvciBvcHRpb25zLlxuICovXG5leHBvcnQgYWJzdHJhY3QgY2xhc3MgVmFsaWRhdG9yPFxuICBWIGV4dGVuZHMgVmFsaWRhdG9yT3B0aW9ucyA9IFZhbGlkYXRvck9wdGlvbnMsXG4+IGV4dGVuZHMgQmFzZVZhbGlkYXRvcjxWLCBmYWxzZT4ge1xuICBwcm90ZWN0ZWQgY29uc3RydWN0b3IoXG4gICAgbWVzc2FnZTogc3RyaW5nID0gREVGQVVMVF9FUlJPUl9NRVNTQUdFUy5ERUZBVUxULFxuICAgIC4uLmFjY2VwdGVkVHlwZXM6IHN0cmluZ1tdXG4gICkge1xuICAgIHN1cGVyKGZhbHNlLCBtZXNzYWdlLCAuLi5hY2NlcHRlZFR5cGVzKTtcbiAgfVxuXG4gIC8qKlxuICAgKiBAZGVzY3JpcHRpb24gVmFsaWRhdGVzIGEgdmFsdWUgYWdhaW5zdCBzcGVjaWZpYyB2YWxpZGF0aW9uIHJ1bGVzXG4gICAqIEBzdW1tYXJ5IEFic3RyYWN0IG1ldGhvZCB0aGF0IG11c3QgYmUgaW1wbGVtZW50ZWQgYnkgYWxsIHZhbGlkYXRvciBzdWJjbGFzc2VzLlxuICAgKiBUaGlzIG1ldGhvZCBjb250YWlucyB0aGUgY29yZSB2YWxpZGF0aW9uIGxvZ2ljIHRoYXQgZGV0ZXJtaW5lcyB3aGV0aGVyIGEgdmFsdWVcbiAgICogaXMgdmFsaWQgYWNjb3JkaW5nIHRvIHRoZSBzcGVjaWZpYyBydWxlcyBvZiB0aGUgdmFsaWRhdG9yLiBJZiB0aGUgdmFsdWUgaXMgdmFsaWQsXG4gICAqIHRoZSBtZXRob2QgcmV0dXJucyB1bmRlZmluZWQ7IG90aGVyd2lzZSwgaXQgcmV0dXJucyBhbiBlcnJvciBtZXNzYWdlLlxuICAgKlxuICAgKiBAdGVtcGxhdGUgViAtIFR5cGUgb2YgdGhlIG9wdGlvbnMgb2JqZWN0IHRoYXQgY2FuIGJlIHBhc3NlZCB0byB0aGUgdmFsaWRhdG9yXG4gICAqIEBwYXJhbSB7YW55fSB2YWx1ZSAtIFRoZSB2YWx1ZSB0byB2YWxpZGF0ZVxuICAgKiBAcGFyYW0ge1Z9IFtvcHRpb25zXSAtIE9wdGlvbmFsIGNvbmZpZ3VyYXRpb24gb3B0aW9ucyBmb3IgY3VzdG9taXppbmcgdmFsaWRhdGlvbiBiZWhhdmlvclxuICAgKiBAcGFyYW0ge1BhdGhQcm94eTxhbnk+fSBwcm94eSAtXG4gICAqIEByZXR1cm4ge3N0cmluZyB8IHVuZGVmaW5lZH0gRXJyb3IgbWVzc2FnZSBpZiB2YWxpZGF0aW9uIGZhaWxzLCB1bmRlZmluZWQgaWYgdmFsaWRhdGlvbiBwYXNzZXNcbiAgICpcbiAgICogQGFic3RyYWN0XG4gICAqXG4gICAqIEBzZWUgTW9kZWwjdmFsaWRhdGVcbiAgICovXG4gIGFic3RyYWN0IG92ZXJyaWRlIGhhc0Vycm9ycyhcbiAgICB2YWx1ZTogYW55LFxuICAgIG9wdGlvbnM/OiBWLFxuICAgIHByb3h5PzogUGF0aFByb3h5PGFueT5cbiAgKTogc3RyaW5nIHwgdW5kZWZpbmVkO1xufVxuIl19