4.2.0 • Published 6 months ago

mask-utils-ccg v4.2.0

Weekly downloads
-
License
MIT
Repository
-
Last release
6 months ago

mask-utils-ccg

🚀 Biblioteca de máscaras para JavaScript e TypeScript, ideal para formatação de números, datas, CPF, CNPJ, telefones e muito mais.

🔗 NPM: mask-utils-ccg

📦 Instalação

Você pode instalar o pacote via npm ou yarn:

Usando npm:

npm install mask-utils-ccg

Usando yarn:

yarn add mask-utils-ccg

🚀 Uso

Importação

JavaScript (CommonJS)

const { maskCPF, maskCNPJ, maskPhone, maskDate, maskCEP, maskRG, maskCreditCard, maskTime, validateCPF } = require('mask-utils-ccg');

TypeScript (ES Modules)

import { maskCPF, maskCNPJ, maskPhone, maskDate, maskCEP, maskRG, maskCreditCard, maskTime, validateCPF } from 'mask-utils-ccg';

Exemplos de Uso

📌 Máscara para CPF

maskCPF("12345678900"); // Saída: "123.456.789-00"

📌 Máscara para CNPJ

maskCNPJ("12345678000195"); // Saída: "12.345.678/0001-95"

📌 Máscara para Telefone

maskPhone("62987654321"); // Saída: "(62) 98765-4321"

📌 Máscara para CEP

maskCEP("72840000"); // Saída: "72.840-000"

📌 Máscara para RG

maskRG("123456789"); // Saída: "12.345.678-9"

📌 Máscara para Cartão de Crédito

maskCreditCard("1234567812345678"); // Saída: "1234 5678 1234 5678"

📌 Máscara para Data (DD/MM/YYYY)

maskDate("20250201"); // Saída: "01/02/2025"

📌 Máscara para Hora (HH:MM)

maskTime("1530"); // Saída: "15:30"

📌 Validação de CPF

validateCPF("12345678900"); // Saída: false
validateCPF("123.456.789-09"); // Saída: true

📚 Lista de Máscaras e Funções Disponíveis

FunçãoDescriçãoExemplo de EntradaExemplo de Saída
maskCPFAplica máscara de CPF"12345678900""123.456.789-00"
maskCNPJAplica máscara de CNPJ"12345678000195""12.345.678/0001-95"
maskPhoneAplica máscara de telefone"62987654321""(62) 98765-4321"
maskCEPAplica máscara de CEP"72840000""72.840-000"
maskRGAplica máscara de RG"123456789""12.345.678-9"
maskCreditCardAplica máscara de cartão de crédito"1234567812345678""1234 5678 1234 5678"
maskDateAplica máscara de data (DD/MM/YYYY)"20250201""01/02/2025"
maskTimeAplica máscara de hora (HH:MM)"1530""15:30"
validateCPFValida um CPF (verifica se é válido)"12345678900"false

💻 Desenvolvimento

Se quiser contribuir com melhorias ou adicionar novas máscaras, siga os passos abaixo:

  1. Clone o repositório:

    git clone https://github.com/MichaelDouglasCA/mask-utils-ccg.git
  2. Instale as dependências:

    npm install
  3. Faça as alterações e rode os testes:

    npm test
  4. Crie um Pull Request.

📜 Licença

Este projeto está sob a licença MIT. Sinta-se livre para usá-lo e contribuir! 😃


Desenvolvido por Michael Douglas 🚀