@igleite/tsutils
Version:
Uma coleção de utilitários em TypeScript para facilitar o desenvolvimento no dia a dia.
110 lines (109 loc) • 5.29 kB
TypeScript
/**
* Classe utilitária para formatação de valores específicos do Brasil formatos comuns utilizados no Brasil.
*/
export declare class BrazilFormatUtils {
private static codigoPlacaMercosul;
/**
* Formata um valor numérico ou string como CPF ou CNPJ.
*
* Se o valor contém 11 dígitos, ele será formatado como um CPF no formato `XXX.XXX.XXX-XX`.
* Se o valor contém 14 dígitos, ele será formatado como um CNPJ no formato `XX.XXX.XXX/XXXX-XX`.
* Se o valor não tiver nem 11 nem 14 dígitos, ele será retornado sem formatação.
*
* @param {string | number} value - O valor a ser formatado como CPF ou CNPJ. Pode ser um número ou uma string.
* @returns {string} - O valor formatado como CPF ou CNPJ, ou o valor original se não tiver o número correto de dígitos.
*/
static formatarCpfCnpj(value: string | number): string;
/**
* Formata um valor numérico ou string como CEP.
*
* O CEP é formatado no formato `XXXXX-XXX`, onde X é um dígito numérico.
* Se o valor não tiver 8 dígitos, ele será retornado sem formatação.
*
* @param {string | number} value - O valor a ser formatado como CEP. Pode ser um número ou uma string.
* @returns {string} - O valor formatado como CEP, ou o valor original se não tiver o número correto de dígitos.
*
* @example
* // Formatação de CEP
* BrazilFormatUtils.formatarCep('12345678'); // Retorna '12345-678'
*
* @example
* // Valor numérico
* BrazilFormatUtils.formatarCep(12345678); // Retorna '12345-678'
*/
static formatarCep(value: string | number): string;
/**
* Formata um valor numérico ou string como telefone.
*
* O telefone é formatado no formato `(XX) XXXXX-XXXX` ou `(XX) XXXX-XXXX`.
* Se o valor não tiver 10 ou 11 dígitos, ele será retornado sem formatação.
*
* @param {string | number} value - O valor a ser formatado como telefone. Pode ser um número ou uma string.
* @returns {string} - O valor formatado como telefone, ou o valor original se não tiver o número correto de dígitos.
*/
static formatarTelefone(value: string | number): string;
/**
* Formata a placa de veículo para os formatos do Brasil ou Mercosul.
*
* Este método verifica se a placa é do tipo Brasil (com 3 letras e 4 números) ou Mercosul (com 3 letras, 1 número,
* 1 letra e 2 números). Em seguida, formata a placa conforme o padrão correspondente.
*
* @param {string} placa - A placa a ser formatada. Pode ser no formato Brasil ou Mercosul.
* @returns {string} - A placa formatada ou uma mensagem de erro se o formato for inválido.
*
* @example
* BrazilFormatUtils.formatarPlaca('ABC1234'); // Retorna 'ABC1234'
* BrazilFormatUtils.formatarPlaca('ABC1D12'); // Retorna 'ABC11212'
*/
static formatarPlaca(placa: string): string;
/**
* Verifica se a placa fornecida está no formato de placa Brasil.
*
* O formato de placa Brasil é composto por 3 letras seguidas de 4 números (exemplo: ABC1234).
*
* @param {string} placa - A placa a ser verificada.
* @returns {boolean} - Retorna `true` se a placa estiver no formato Brasil, caso contrário `false`.
*
* @example
* BrazilFormatUtils.isPlacaBrasil('ABC1234'); // Retorna true
*/
private static isPlacaBrasil;
/**
* Verifica se a placa fornecida está no formato de placa Mercosul.
*
* O formato de placa Mercosul é composto por 3 letras, 1 número, 1 letra e 2 números (exemplo: ABC1D12).
*
* @param {string} placa - A placa a ser verificada.
* @returns {boolean} - Retorna `true` se a placa estiver no formato Mercosul, caso contrário `false`.
*
* @example
* BrazilFormatUtils.isPlacaMercosul('ABC1D12'); // Retorna true
*/
private static isPlacaMercosul;
/**
* Gera a placa no formato Brasil, substituindo o dígito numérico pela letra correspondente.
*
* Este método pega a placa e substitui o dígito numérico pela letra correspondente no Map de `codigoPlacaMercosul`.
*
* @param {string} placa - A placa a ser gerada.
* @param {number} pos - A posição do dígito que deve ser substituído pela letra.
* @returns {string} - A placa gerada com a letra correspondente.
*
* @example
* BrazilFormatUtils.gerarPlacaBrasil('ABC1234', 4); // Retorna 'ABC1234'
*/
private static gerarPlacaBrasil;
/**
* Gera a placa no formato Mercosul, substituindo a letra pela correspondente ao número.
*
* Este método pega a letra da placa e substitui por um número correspondente, de acordo com o Map de `codigoPlacaMercosul`.
*
* @param {string} placa - A placa a ser gerada.
* @param {number} pos - A posição da letra que deve ser substituída pelo número.
* @returns {string} - A placa gerada com o número correspondente à letra.
*
* @example
* BrazilFormatUtils.gerarPlacaMercosul('ABC1D12', 4); // Retorna 'ABC11212'
*/
private static gerarPlacaMercosul;
}