theuves / cpf

Validar, formatar e gerar números de CPF (validate, format and generate CPF numbers 🇧🇷).

cpf

Functions to handle Brazilian CPF numbers

---

Precisando de um desenvolvedor? Entre em contato: [email protected]

---

Installation

You can install it with npm or yarn.

Try:

• npm: npm install cpf
• yarn: yarn add cpf

Usage

const CPF = require('cpf');

Now, CPF is a object with some functions:

• format
• generate
• isValid

CPF.format(cpf)

Format a CPF number.

Example

CPF.format('11144477735');
//=> '111.444.777-35'

Parameters

• cpf {string} A CPF number.

Returns a string with the formatted CPF number.

CPF.generate(formatted, invalid)

Generate a random CPF number.

Parameters

• formatted {boolean} true by default. It will generate a formatted CPF number.
• invalid {boolean} false by default. It will generate a invalid CPF number.

Returns a CPF number.

CPF.isValid(cpf, byLength)

Check if a CPF number is valid.

Example

CPF.isValid('111.444.777-35');
// true

CPF.isValid('111.444.777-42');
// false

CPF.isValid('111.444.777-42', true);
// true

CPF.isValid('111.444.777', true);
// false

Parameters

• cpf {string} Check if the CPF number is valid.
• byLength {boolean} false by default. Check only if the length is valid.

Returns the check result.

License

MIT © Matheus Alves

cpf's Issues

Melhorar a função format

Atualmente a função format só faz a formatação se o CPF tem 11 dígitos. Seria interessante que ela fizesse a formatação pra qualquer quantidade de dígitos, aí ela poderia ser usada durante a digitação de campos. Posso abrir um Pull Request pra fazer essa modificação.

Sobre utilização da biblioteca para projeto Web

Boa Tarde

Ola tudo bom

Gostaria de estar efetuando testes com a sua biblioteca

Como eu utilizo a mesma ?

Executei o comando em meu terminal e foi criado uma pasta node_modules

Pretendo usar em um projeto para a Web

add tests

please add tests

Não válida CPF com o mesmo número ex:. "11111111111"

import * as CPF from 'cpf'; CPF.isValid('11111111111');
Retorna "true" o caso acima

Reduce of empty array with no initial value

Looks like this is fixed on master, can you release a new version?

Failed to minify the code from this file: calc-dv.js

Ao criar um projeto React usando a ferramenta "create-react-app" e instalar o modulo "cpf", no momento de fazer o "build" da aplicação encontramos o erro abaixo:

Failed to minify the code from this file: "./node_modules/cpf/lib/calc-dv.js:9"

Isso é causado porque na linha 9 do arquivo calc-dv.js é utilizado "function definitions" que é uma spec ES6 conforme mostra documentação (https://developer.mozilla.org/pt-BR/docs/Web/JavaScript/Reference/Functions/Parametros_Predefinidos).

Por isso no momento de realizar o "minify" do projeto o webpack do react detecta isso e ocorre o erro por questões de compatibilidade em navegadores mais antigos. vide documentação do create-react-app: (https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#npm-run-build-fails-to-minify)

Incluir o index.d.ts no release

O index.d.ts precisa estar no pacote de release