Skip to content

Custom Validator ​

Los validators personalizados permiten definir reglas de validación de la aplicación sin agregar nuevos validators integrados. Se pueden usar en campos de interface y parámetros de función, y se ejecutan de forma síncrona cuando se comprueba el valor decorado.

Declaración ​

Declara un validator con validator function o validator const. El primer parámetro debe tener un tipo explícito y llamarse value; los parámetros opcionales de configuración van después y reciben los argumentos posicionales escritos en el decorator. La función devuelve la unión Validator. Un resultado válido es { isValid: true }; un fallo devuelve { isValid: false, message: "..." }.

El compilador proporciona el valor del campo o parámetro decorado como value. Por ejemplo, @hasPrefix("user_") llama al validator con el valor primero y "user_" como argumento de configuración. Usa paréntesis vacíos para validators sin configuración, como @hasNoSpaces().

Ejemplo ​

tyrus
type Validator = { isValid: true } | { isValid: false; message: string };

validator function hasPrefix(value: string, constraint: string): Validator {
    if (!value.startsWith(constraint)) {
        return { isValid: false, message: "Value must start with the configured prefix" };
    }
    return { isValid: true };
}

validator const hasNoSpaces = (value: string): Validator => {
    if (value.includes(" ")) {
        return { isValid: false, message: "Value cannot contain spaces" };
    }
    return { isValid: true };
};

interface UserInput {
    @hasPrefix("user_")
    @hasNoSpaces()
    username: string;
}

function acceptUsername(@hasNoSpaces() value: string): string {
    return value;
}

const main = (): void => {
    try {
        const user: UserInput = { username: "guest user" };
        print(user.username);
    } catch (error: ValidationError) {
        print(error.issues.length);
        print(error.issues[0].target);
        print(error.issues[0].validator);
        print(error.issues[0].message);
        print(error.issues[1].validator);
        print(error.issues[1].message);
    }
};

Mensajes devueltos ​

Un validator personalizado elige su mensaje de fallo al devolver { isValid: false, message }. Ese mensaje se incluye en el ValidationIssue resultante; el valor comprobado no se inserta automáticamente. Un fallo lanza ValidationError, por lo que la función que lo contiene debe capturarlo o declarar throws ValidationError.