my-utils-engine
v1.0.2
Published
Funções utilitárias para projetos em Angola (BI, telefone, currency, etc.) Comentários: os comentários no código estão em português. Nomes de funções em inglês.
Downloads
20
Maintainers
Readme
my-utils-engine my-utils-engine é uma biblioteca de utilitários em TypeScript com um conjunto de funções que eu uso com frequência no meu dia a dia de programação. O objetivo é fornecer soluções rápidas e confiáveis para tarefas comuns, desde formatação de dados até validações específicas de Angola.
Instalação Você pode instalar a biblioteca usando npm:
npm install my-utils-engine
Como Usar A biblioteca é construída em um padrão de barril de exportação, o que permite importar apenas as funções que você precisa.
import { capitalize, formatCurrency } from 'my-utils-engine';
const textoFormatado = capitalize('olá mundo'); console.log(textoFormatado); // 'Olá mundo'
const valorEmKz = formatCurrencyKz(50000); console.log(valorEmKz); // 'Kz 50 000,00'
Funções Essenciais Aqui estão algumas das funções mais úteis e frequentemente usadas desta biblioteca:
- validateBI Descrição: Valida um número de Bilhete de Identidade (BI) angolano. A função pode fazer uma validação simples com base no formato e também uma validação remota para confirmar a autenticidade do número, se necessário.
Uso:
TypeScript
import { validateBI } from 'my-utils-engine';
// Exemplo de validação simples const biValido = '000000000LA001'; console.log(validateBI(biValido)); // true
const biInvalido = '123456789'; console.log(validateBI(biInvalido)); // false 2. formatCurrencyKz Descrição: Formata um valor numérico para o padrão de moeda angolana (Kwanza). Ideal para exibir preços ou valores monetários de forma clara para o usuário.
Uso:
TypeScript
import { formatCurrencyKz } from 'my-utils-engine';
const valor1 = 15000; console.log(formatCurrencyKz(valor1)); // 'Kz 15 000,00'
const valor2 = 12500.55; console.log(formatCurrencyKz(valor2)); // 'Kz 12 500,55' 3. validatePhoneAO Descrição: Valida um número de telefone angolano, verificando se ele segue o formato e a quantidade de dígitos corretos.
Uso:
TypeScript
import { validatePhoneAO } from 'my-utils-engine';
const telefoneValido = '923123456'; console.log(validatePhoneAO(telefoneValido)); // true
const telefoneInvalido = '987654321'; console.log(validatePhoneAO(telefoneInvalido)); // false Todas as Funções Aqui está uma lista de todas as funções incluídas na biblioteca. Para mais detalhes sobre cada uma, consulte a documentação no código-fonte.
addDays
capitalize
delay
formatCurrencyKz
formatDate
generateId
isEmpty
maskString
paginate
toSlug
validateBI
validatePhoneAO
Contribuição Contribuições são bem-vindas! Se você tiver ideias para novas funções ou melhorias, sinta-se à vontade para abrir uma issue ou um pull request.
