cpf-authenticator

Pacote desenvolvido em JavaScript que realiza validação do CPF.

Instalação

npm install cpf-autheticator

Usando

Após instalar o pacote, realize a importação dele no arquivo em que desejar utilizar a validação do cpf. Veja formas de fazer isso:

import cpf from 'cpf-authenticator';
const isValid = cpf.cpfAuthenticator('números_do_cpf_como_string');

Ou

import { cpfAuthenticator } from 'cpf-authenticator';
const isValid = cpfAuthenticator('números_do_cpf_como_string');

O retorno da função será true (CPF válido) ou false (CPF inválido).

Deve ser passado uma string como parâmetro da função cpfAuthenticator. Essa string pode ser formada apenas pelos números do CPF ou pelos números na máscara (nnn.nnn.nnn-nn);

Você também pode definir se um CPF com números repetidos (ex.: 999.999.999-99) será válido ou não. Um CPF composto de números repetidos é inválido na prática, porém, passa pela algoritmo de verificação. Você pode definir se aceita ou não, utilizando um segundo parâmetro como false na função cpfAuthenticator.

import { cpfAuthenticator } from 'cpf-authenticator';
const isValid = cpfAuthenticator('números_do_cpf_como_string', false); //números repetidos não serão válidos

Configuração para Desenvolvimento

Para fazer a instalação das dependências, baixe os arquivos que compõe o projeto. Será necessário ter o NodeJS instalado na sua máquina. No terminal, acesse a pasta em que os arquivos estão e digite o seguinte código:

npm install

Será feito a instalação de todas as dependências do projeto.

Histórico de lançamentos

• 1.0.3
  • Adição de ferramenta para retornar como false CPF com números repetidos.
• 1.0.2
  • Versão inicial.

Meta

Rilton Moreira – [e-mail]

Contribuindo

1. Faça o fork do projeto (https://github.com/RiltonSM/cpf-authenticator/fork)
2. Crie uma branch para sua modificação (git checkout -b feature/fooBar)
3. Faça o commit (git commit -am 'Add some fooBar')
4. Push (git push origin feature/fooBar)
5. Crie um novo Pull Request