cpf-cnpj-utils

A zero-dependency simple toolkit to deal with CPFs and CNPJs written in Typescript.

Installation

• yarn

yarn add @julioakira/cpf-cnpj-utils

• npm

npm i @julioakira/cpf-cnpj-utils

Usage

You can import or require CPF, CNPJ or both in your code.

1import { CPF, CNPJ } from '@julioakira/cpf-cnpj-utils'
2
3const { CPF, CNPJ } = require('@julioakira/cpf-cnpj-utils');

Both CPF and CNPJ packages have the same functionalities:

• Format - Formats and unformatted CPF/CNPJ.
• Strip - Strips a formatted CPF/CNPJ.
• Validate - Validates a formatted or unformatted CPF/CNPJ.
• Generate - Generates a valid CPF/CNPJ.

1// Returns 30.306.294/0001-45
2const formatted = CNPJ.Format('30306294000145');
3
4// Returns 30306294000145
5const stripped = CNPJ.Strip('30.306.294/0001-45');
6
7// Generates a valid unformatted CNPJ
8const cnpj = CNPJ.Generate()
9
10// Generates a valid formatted CNPJ
11const cnpj = CNPJ.Generate(true);
12
13// Returns true for valid and false for invalid
14const valid = CNPJ.Validate('30306294000145')
15const valid = CNPJ.Validate('30.306.294/0001-45');
16
17const invalid = CNPJ.Validate('30306294000155');
18const invalid = CNPJ.Validate('30.306.294/0001-55');

1// Returns 606.772.720-06
2const formatted = CPF.Format('60677272006');
3
4// Returns 60677272006
5const stripped = CPF.Strip('606.772.720-06');
6
7// Generates a valid unformatted CPF
8const cpf = CPF.Generate()
9
10// Generates a valid formatted CNPJ
11const cpf = CPF.Generate(true);
12
13// Returns true for valid and false for invalid
14const valid = CPF.Validate('60677272006')
15const valid = CPF.Validate('606.772.720-06');
16
17const invalid = CPF.Validate('40308985062');
18const invalid = CPF.Validate('403.089.850-62');

Variable Length CPFs and CNPJs

Some CPFs and CNPJs might have variable lengths and not be zero padded up to their regular length. The validate function has a optional zero_pad argument, which is true by default but can be manually set to false if desired:

1//  CNPJ with 13 digits returns true
2const valid = CNPJ.Validate('4307650002502');
3
4// Setting auto zero padding to false invalidates and returns false
5const invalid = CNPJ.Validate('4307650002502', false);
6

1//  CPF with 10 digits returns true
2const valid = CPF.Validate('2204306240');
3
4// Setting auto zero padding to false invalidates and returns false
5const invalid = CNPJ.Validate('2204306240', false);
6

Tests

Tests are handled by Jest.

• yarn

yarn test

• npm

npm test