Luciano655dev / better-format

Um pacote NPM para facilitar a formatação de variaveis e conseguir detalhes sobre elas
8 stars 2 forks source link

better-format

GitHub repo size GitHub language count GitHub forks Bitbucket open issues Bitbucket open pull requests

Um Pacote NPM para facilitar sua vida na hora de formatar e pegar informações sobre variáveis
Acesse o projeto no site do NPM
Acesse o projeto no GitHub

Ajustes e melhorias

O projeto ainda está em desenvolvimento, com o tempo, novas funcionalidades serão adicionadas, como:

💻 Pré-requisitos

Para instalar este pacote, você precisa:

📖 Como ler a documentação

As funções estarão nesse formato:

NomeDaFunção()

NomeDaFunção(parametroObrigatório, ?parametroOpicional)

Explicação da função

Parametros

🧪 Como fazer um teste

📞 Contato

📫 Contribua

Para contribuir com esse projeto, siga estas etapas:

  1. Bifurque este repositório.
  2. Crie um branch: git checkout -b <nome_branch>.
  3. Faça suas alterações e confirme-as: git commit -m '<mensagem_commit>'
  4. Envie para o branch original: git push origin <nome_do_projeto> / <local>
  5. Crie a solicitação de pull.

Como alternativa, consulte a documentação do GitHub em como criar uma solicitação pull.

🤝 Colaboradores

Agradecemos às seguintes pessoas que contribuíram para este projeto:


Luciano655dev

Yagasaki7K

Nick-Gabe



As informações do projeto começam aqui



🚀 Instalação

Para instalar, é só rodar o comando:

npm i better-format

☕ Como utilizar

Primeiro, coloque um require no topo dos arquivos que você irá utilizar, por exemplo:

const bt = require('better-format');

Você pode colocar o nome que preferir no lugar de bt

🖥️ Funções

FormatString()

bf.FormatString(string, ?{ wordCase, removeSpaces, removeSpecialChars, capitalize }, ?{ obscenities, censorshipChar, leetspeak })

Essa função irá:

RemoveCurseWords()

bf.RemoveCurseWords(string, ?obscenities, ?censorshipChar, ?leetspeak)

Essa função irá censurar palavrões e palaras específicas. Mesma utilizada na FormatString()

Parametros

ValidateCPF()

bf.ValidateCPF(cpf)

Essa função irá validar um CPF, retornando true se for válido e false se for inválido.

Parametros

ValidateCNPJ()

bf.ValidateCNPJ(cnpj)

Essa função irá validar um CNPJ, retornando true se for válido e false se for inválido.

Parametros

ValidateCEP()

await bf.ValidateCEP(cep)

Essa função irá validar e retornar as informações de um CEP de acordo com a API ViaCEP. NOTA: Essa é uma PROMISE, portanto, para utiliza-la, será preciso do .then().catch() ou de uma função assíncrona (async/await)

Parametros

ValidatePhoneNumber()

bf.ValidatePhoneNumber(phoneNumber, ?localização)

Essa função irá validar um Número de Telefone de qualquer país, mais informações Aqui.

Parametros

ValidateEmail()

bf.ValidateEmail(email)

Essa função irá validar um e-mail, retornando true se for válido e false se for inválido.

Parametros

ParseURL()

bf.ParseURL(url)

Essa função irá retornar informações diversas sobre uma URL.

Parametros

ValidateCreditCard()

bf.ValidateCreditCard(creditCardNumber)

Essa função irá validar um cartão, retornando true e bank (string) se for válido e false se for inválido.

Parametros

ValidatePassword()

bf.ValidatePassword(password, ?{ minLength, needNumbers, needUppercaseLetters, needSpecialChars, commonWords })

Essa função irá validar uma senha, retornando uma pontuação para ela, mostrando se é ou não é válida e retornando os testes aprovados e recusados.

Parametros