logitar-validation/dist/rules/maximumLength.js

JavaScript validation library distributed by Logitar.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
/**
 * A validation rule that checks if a string or an array is shorter than a maximum length.
 * @param value The value to validate.
 * @param args The maximum length.
 * @returns The result of the validation rule execution.
 */
const maximumLength = (value, args) => {
    const maximumLength = Number(args);
    if (isNaN(maximumLength) || maximumLength <= 0) {
        return { severity: "warning", message: "The arguments should be a positive number." };
    }
    if (typeof value === "string") {
        if (value.length > maximumLength) {
            return { severity: "error", message: "{{name}} must be at most {{maximumLength}} character(s) long." };
        }
    }
    else if (Array.isArray(value)) {
        if (value.length > maximumLength) {
            return { severity: "error", message: "{{name}} must contain at most {{maximumLength}} element(s)." };
        }
    }
    else {
        return { severity: "error", message: "{{name}} must be a string or an array." };
    }
    return { severity: "information" };
};
exports.default = maximumLength;