cpf
Functions to handle brazilian CPF numbers
Installation
You can install it with npm or yarn.
Try:
- npm:
npm install cpf
- yarn:
yarn add cpf
Usage
const CPF = ;
Now, CPF
is a object with some functions:
format
generate
isValid
CPF.format(cpf)
Format a CPF number.
Example
CPF;//=> '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;// true CPF;// false CPF;// true CPF;// 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