Skip to content

README.md

Latest commit

 

History

History
131 lines (90 loc) · 5.67 KB

README.md

File metadata and controls

131 lines (90 loc) · 5.67 KB
Raw

ValidationUtils

The ValidationUtils class provides a collection of utility methods for validating common data formats such as emails, URLs, phone numbers, hex colors, JSON strings, and Brazilian documents (CPF, CNPJ, RG).

Basic Usage

import { ValidationUtils } from '@brmorillo/utils';

// Validate an email address
const validEmail = ValidationUtils.isValidEmail({ email: 'test@example.com' });
console.log(validEmail); // true

// Validate a URL
const validUrl = ValidationUtils.isValidURL({ inputUrl: 'https://example.com' });
console.log(validUrl); // true

// Validate a Brazilian CPF
const validCpf = ValidationUtils.isValidCPF({ cpf: '123.456.789-09' });
console.log(validCpf); // true or false depending on the CPF validity

Methods

isValidEmail({ email })

Validates if a string is a valid email address.

ValidationUtils.isValidEmail({ email: 'test@example.com' }); // true
ValidationUtils.isValidEmail({ email: 'invalid-email' }); // false

isValidURL({ inputUrl })

Validates if a string is a valid URL (only http: and https: protocols are allowed). The host is parsed with the URL constructor and rejected if it contains an empty label (e.g. example..com). A .. sequence appearing in the path or query string is allowed and does not cause rejection.

ValidationUtils.isValidURL({ inputUrl: 'https://example.com' }); // true
ValidationUtils.isValidURL({ inputUrl: 'https://example.com/a/../b' }); // true (`..` in path)
ValidationUtils.isValidURL({ inputUrl: 'https://example..com' }); // false (empty host label)
ValidationUtils.isValidURL({ inputUrl: 'invalid-url' }); // false

isValidPhoneNumber({ phoneNumber })

Validates a digits-only phone number in a simplified E.164-like format: an optional leading +, a first digit of 1–9, then 9 to 14 more digits (10–15 digits total). This is a format/length check only; it does not validate country/area codes or whether the number is assignable, and separators such as spaces, parentheses or dashes are not accepted.

ValidationUtils.isValidPhoneNumber({ phoneNumber: '+1234567890' }); // true
ValidationUtils.isValidPhoneNumber({ phoneNumber: '12345' }); // false
ValidationUtils.isValidPhoneNumber({ phoneNumber: '+1 (234) 567-890' }); // false (contains separators)

isNumber({ value })

Validates if a value is a finite number or a decimal numeric string. The value parameter is typed as unknown. Booleans, null/undefined, empty or whitespace-only strings, non-finite numbers (NaN, Infinity, -Infinity) and non-decimal numeric strings such as '0x1F', '0b101' or '0o17' are all rejected.

ValidationUtils.isNumber({ value: 123 }); // true
ValidationUtils.isNumber({ value: '123' }); // true (can be parsed as a number)
ValidationUtils.isNumber({ value: 'abc' }); // false
ValidationUtils.isNumber({ value: '   ' }); // false (whitespace only)
ValidationUtils.isNumber({ value: '0x1F' }); // false (non-decimal)
ValidationUtils.isNumber({ value: true }); // false (boolean)

isValidHexColor({ hexColor })

Validates if a string is a valid hexadecimal color code (full or shorthand format).

ValidationUtils.isValidHexColor({ hexColor: '#FFFFFF' }); // true
ValidationUtils.isValidHexColor({ hexColor: '#F00' }); // true (shorthand format)
ValidationUtils.isValidHexColor({ hexColor: '123456' }); // false (missing #)

hasMinLength({ input, minLength })

Validates if a string has at least the specified minimum length.

ValidationUtils.hasMinLength({ input: 'hello', minLength: 3 }); // true
ValidationUtils.hasMinLength({ input: 'hi', minLength: 3 }); // false

hasMaxLength({ input, maxLength })

Validates if a string does not exceed the specified maximum length.

ValidationUtils.hasMaxLength({ input: 'hello', maxLength: 10 }); // true
ValidationUtils.hasMaxLength({ input: 'this is too long', maxLength: 5 }); // false

isValidJSON({ jsonString })

Validates if a string is a valid JSON string.

ValidationUtils.isValidJSON({ jsonString: '{"key": "value"}' }); // true
ValidationUtils.isValidJSON({ jsonString: '{invalid: json}' }); // false

isValidCPF({ cpf })

Validates if a string is a valid CPF (Brazilian individual taxpayer registry number). Accepts formatted or unformatted input.

ValidationUtils.isValidCPF({ cpf: '123.456.789-09' }); // true or false depending on the CPF validity
ValidationUtils.isValidCPF({ cpf: '12345678909' }); // true or false depending on the CPF validity

isValidCNPJ({ cnpj })

Validates if a string is a valid CNPJ (Brazilian company registry number). Accepts formatted or unformatted input.

ValidationUtils.isValidCNPJ({ cnpj: '12.345.678/0001-90' }); // true or false depending on the CNPJ validity
ValidationUtils.isValidCNPJ({ cnpj: '12345678000190' }); // true or false depending on the CNPJ validity

isValidRG({ rg, state })

Validates the FORMAT of a Brazilian RG (ID document). This is a format/length check only and does NOT perform real check-digit validation. After stripping non-alphanumeric characters it verifies the cleaned value is 5–12 characters consisting of digits with an optional trailing X/x. When state: 'SP' is provided a slightly stricter (but still simplified) path requires exactly 9 characters with a numeric 8-digit body and a numeric or X check character — it does NOT compute the real São Paulo check digit. Other states fall back to the generic format check.

ValidationUtils.isValidRG({ rg: '12.345.678-9' }); // true for valid format

ValidationUtils.isValidRG({ rg: '123456789', state: 'SP' }); // true for valid format for São Paulo