Giter VIP home page Giter VIP logo

cpf-authenticator's Introduction

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 – [email protected]

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

cpf-authenticator's People

Contributors

riltonsm avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.