@decaf-ts/decorator-validation/lib/esm/validation/Validators/MaxValidator.d.ts

simple decorator based validation engine

import { Validator } from "./Validator";
import { MaxValidatorOptions } from "../types";
/**
 * @description Validator for checking if a value is less than or equal to a maximum
 * @summary The MaxValidator checks if a numeric value, date, or string is less than or equal to
 * a specified maximum value. It supports comparing numbers directly, dates chronologically,
 * and strings lexicographically. This validator is typically used with the @max decorator.
 *
 * @param {string} [message] - Custom error message to display when validation fails, defaults to {@link DEFAULT_ERROR_MESSAGES#MAX}
 *
 * @class MaxValidator
 * @extends Validator
 *
 * @example
 * ```typescript
 * // Create a max validator with default error message
 * const maxValidator = new MaxValidator();
 *
 * // Create a max validator with custom error message
 * const customMaxValidator = new MaxValidator("Value must not exceed {0}");
 *
 * // Validate a number
 * const numOptions = { max: 100, message: "Number too large" };
 * const numResult = maxValidator.hasErrors(50, numOptions); // undefined (valid)
 * const invalidNumResult = maxValidator.hasErrors(150, numOptions); // Returns error message (invalid)
 *
 * // Validate a date
 * const dateOptions = { max: new Date(2023, 11, 31) };
 * const dateResult = maxValidator.hasErrors(new Date(2023, 5, 15), dateOptions); // undefined (valid)
 * ```
 *
 * @mermaid
 * sequenceDiagram
 *   participant C as Client
 *   participant V as MaxValidator
 *
 *   C->>V: new MaxValidator(message)
 *   C->>V: hasErrors(value, options)
 *   alt value is undefined
 *     V-->>C: undefined (valid)
 *   else value is Date and max is not Date
 *     V->>V: Convert max to Date
 *     alt conversion fails
 *       V-->>C: Error: Invalid Max param
 *     end
 *   end
 *   alt value > max
 *     V-->>C: Error message
 *   else value <= max
 *     V-->>C: undefined (valid)
 *   end
 *
 * @category Validators
 */
export declare class MaxValidator extends Validator<MaxValidatorOptions> {
    constructor(message?: string);
    /**
     * @description Checks if a value is less than or equal to a maximum
     * @summary Validates that the provided value does not exceed the maximum value
     * specified in the options. For dates, it performs chronological comparison,
     * converting string representations to Date objects if necessary. For numbers
     * and strings, it performs direct comparison.
     *
     * @param {number | Date | string} value - The value to validate
     * @param {MaxValidatorOptions} options - Configuration options containing the maximum value
     *
     * @return {string | undefined} Error message if validation fails, undefined if validation passes
     *
     * @override
     *
     * @see Validator#hasErrors
     */
    hasErrors(value: number | Date | string, options: MaxValidatorOptions): string | undefined;
}