Custom Validator
Validators personalizados permitem definir regras de validação da aplicação sem adicionar novos validators nativos. Eles podem ser usados em campos de interface e parâmetros de função e executam de forma síncrona quando o valor decorado é verificado.
Declaração
Declare um validator com validator function ou validator const. O primeiro parâmetro deve ter tipo explícito e se chamar value; parâmetros opcionais de configuração vêm depois e recebem os argumentos posicionais escritos no decorator. A função retorna a união Validator. Um resultado válido é { isValid: true }; uma falha retorna { isValid: false, message: "..." }.
O compilador fornece o valor do campo ou parâmetro decorado como value. Por exemplo, @hasPrefix("user_") chama o validator com o valor primeiro e "user_" como argumento de configuração. Use parênteses vazios para validators sem configuração, como @hasNoSpaces().
Exemplo
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);
}
};Mensagens retornadas
Um validator personalizado escolhe a mensagem de falha retornando { isValid: false, message }. Essa mensagem é incluída no ValidationIssue resultante; o valor verificado não é inserido automaticamente. Uma falha lança ValidationError, então a função que o contém deve capturá-lo ou declarar throws ValidationError.
