cpf-check

cpf-check

CPF Validator, Generator e Formatter, runs both on browser and server-side. Incredibly Small 2.2KB (890bytes gziped!!).

Instalation

Add the latest version of cpf-check to your package.json.

npm install cpf-check --save

Then you can use it in your index.html

<script type="text/javascript" src="./node_modules/cpf-check/dist/cpf.min.js"></script>
// window.CPF

Or, you can import it as a module:

const CPF = require('cpf-check');

// or, in ES6

import CPF from 'cpf-check';

Works on Node, any CommonJs Env. and as an AMD modules.

Usage & API

CPF(String): Boolean

The main export is a function that validates CPFs.

const CPF = require('cpf-check')
const myCpf = '676.754.677-10';

CPF(myCpf);
// true

CPF.validate(myCpf);
// true

The CPF.validate() is an alias for the CPF() method.

CPF.generate(): String

Generates valid CPFs:

CPF.generate();
// '676.754.677-10'

CPF.parse(String): String

Parse CPFs from text strings:

const myText = 'Hey, my CPF is 676.754.677-10';

CPF.parse(myText);
// '676.754.677-10'

CPF.format(String): String

Format (beautify) CPF strings:

const myCpf = '67675467710';

CPF.format(myCpf);
// '676.754.677-10'

CPF.strip(String): String

Strip (uglify) CPF strings:

const myCpf = '676.754.677-10';

CPF.strip(myCpf);
// '67675467710'

PRs

And if you find something that is not working as supposed to, please, open a PR.

Bonus!

If you're curious to know how this module works before implementing it, the source code is heavily commented! head to src/index.js to take a look!

Copyright and License

Copyright (c) 2017 Marcel Coelho under the MIT license