Package Exports

dochelper
dochelper/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (dochelper) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

dochelper

Bibilioteca para validar, gerar e formatar CPF e CNPJ.

Possui definições de tipo para o TypeScript.

Instalação

npm install dochelper

// CommonJS
const dochelper = require("dochelper");

// ES6
import * as dochelper from "dochelper";

Módulos

CPF
CNPJ

CPF

dochelper.CPF.validate(str: string)

Retorna se o CPF é válido. A entrada pode ser com ou sem máscara.

console.log(dochelper.CPF.validate('111.444.777-35')); 
// true
console.log(dochelper.CPF.validate('11144477735')) 
// true
console.log(dochelper.CPF.validate('111.444.777-31')); 
// false

dochelper.CPF.generate(formatted?: boolean)

Retorna um CPF válido gerado randomicamente. Para gerar com máscara, informe "true" como parâmetro da função.

console.log(dochelper.CPF.generate()); 
// e.g. 67152064229
console.log(dochelper.CPF.generate(true)); 
// e.g. 755.506.286-00

dochelper.CPF.format(str: string)

Retorna a entrada formatada como CPF.

Irá retornar nulo se sua entrada estiver fora do padrão de um CPF com/sem máscara.

console.log(dochelper.CPF.format('11144477735')); 
// 111.444.777-35

dochelper.CPF.unformat(str: string)

Retorna a entrada sem a formatação de CPF.

Irá retornar nulo se sua entrada estiver fora do padrão de um CPF com/sem máscara.

console.log(dochelper.CPF.unformat('111.444.777-35')); 
// 11144477735

CNPJ

dochelper.CNPJ.validate(str: string)

Retorna se o CNPJ é válido. A entrada pode ser com ou sem máscara.

console.log(dochelper.CNPJ.validate('11.444.777/0001-61')); 
// true
console.log(dochelper.CNPJ.validate('11444777000161')); 
// true
console.log(dochelper.CNPJ.validate('11.444.777/0001-62')); 
// false
console.log(dochelper.CNPJ.validate('11444777000162')); 
// false

dochelper.CNPJ.generate(formatted?: boolean)

Retorna um CNPJ válido gerado randomicamente. Para gerar com máscara, informe "true" como parâmetro da função.

console.log(dochelper.CNPJ.generate()); 
// e.g 33213356108109
console.log(dochelper.CNPJ.generate(true)); 
// e.g. 35.834.446/5742-91

dochelper.CNPJ.format(str: string)

Retorna a entrada formatada como CNPJ.

Irá retornar nulo se sua entrada estiver fora do padrão de um CNPJ com/sem máscara.

console.log(dochelper.CNPJ.format('11444777000161')); 
// 11.444.777/0001-61

dochelper.CNPJ.unformat(str: string)

Retorna a entrada sem a formatação de CNPJ.

Irá retornar nulo se sua entrada estiver fora do padrão de um CNPJ com/sem máscara.

console.log(dochelper.CNPJ.unformat('11.444.777/0001-61')); 
// 11444777000161

Licença

O código fonte está disponibilizado conforme a licença MIT.