Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

gerador-br

Gerador de Dados Fictícios - Brasil

gerador, dados, faker, faker-br, cpf, cnpj, cnpj alfanumérico, inscrição estadual, rg, cnh, pis, titulo-eleitor, certidão, cns, passaporte, certidão de nascimento, certidão de casamento, certidão de óbito, placa, renavam, endereço, telefone, nome, nome empresa, data nascimento, estado, estado civil, profissão, nacionalidade, escolaridade, cor pele, tipo sanguíneo, orientação sexual, identidade de gênero, nome do pai, nome da mãe, palavra, Lorem ipsum, apelido, provedor, email, profissão, escolaridade, Mocha, Chai, Jest, Sinon, Supertest, Nock, Cypress, Playwright, Puppeteer, Enzyme, Node.js Test Runner, gerador de dados fictífios, fake data generator, mock, test, testes, automation, gênero, orientação sexual, identidade de gênero

readme

gerador-br gerador-br

NPM version NPM downloads jsDelivr CodeQL CI Test ESLint Coverage FOSSA Licence FOSSA Security

Gerador de Dados Fictícios - Brasil Gere dados fictícios/válidos, para testes e desenvolvimento de Software.

Ideal para testes automatizados com Cypress, Playwright, Jest, Node.js Test Runner, Jasmine, Mocha, Chai, Supertest, Sinon e Puppeteer.

O pacote fornece uma coleção de funções para gerar dados brasileiros aleatórios, como:

Instalação

npm install gerador-br
yarn add gerador-br

Importação

ES Module

import { gerar } from 'gerador-br';

CommonsJS

const gerar = require('gerador-br');

Utilização

Veja todos os exemplos na documentação.

Importe apenas a(s) função(ões) que desejar:

import { nome, cpf, cnpj, placaMercosul } from 'gerador-br'; // ES Module
// const { nome, cpf, cnpj, placaMercosul } = require('gerador-br'); // CommonJS

console.log(nome.femininoCompleto());
console.log(cpf());
console.log(cnpj());
console.log(placaMercosul());

Ou, importe todo o módulo gerar e depois use qualquer função que desejar:

import { gerar } from 'gerador-br'; // ES Module:
// const gerar = require('gerador-br'); // CommonJS:

console.log(gerar.nome.femininoCompleto());
console.log(gerar.cpf());
console.log(gerar.cnpj());
console.log(gerar.contaBancaria());
console.log(gerar.cartaoCredito());

Outros exemplos:

import { gerar } from 'gerador-br'; // ES Module:
// const gerar = require('gerador-br'); // CommonJS:

/* ******************** APELIDO ************************ */
// Gera apelido aleatório
console.log(gerar.apelido());

/* ******************** BANCOS ************************ */
// Gera dados de um banco aleatório
console.log(gerar.banco());

// Gera dados do banco informado
console.log(gerar.banco(237));

// Retorna uma lista de códigos de bancos
console.log(gerar.listaCodigosBancos());

/* ******************** CARTÃO DE CRÉDITO ************* */
// Gera objeto cartaoCredito com propriedades básicas
console.log(gerar.cartaoCredito());

// Gera com máscara e nome informado
console.log(gerar.cartaoCredito(true, 'João Santos da Silva'));

// Gera sem máscara e nome informado
console.log(gerar.cartaoCredito(false, 'Maria Aparecida Reis'));

/* ******************** CELULAR *********************** */
// Gera celular sem máscara, estado e operadora aleatórios
console.log(gerar.celular());

// Gera celular com máscara
console.log(gerar.celular(true));

// Gera celular para estado específico
console.log(gerar.celular(false, 'SC'));
console.log(gerar.celular(true, 'ES'));

// Gera celular para operadora específica
console.log(gerar.celular(false, '', 'Claro'));
console.log(gerar.celular(true, 'MS', 'Vivo'));

/* ******************** CEP *************************** */
// Gera CEP sem máscara
console.log(gerar.cep());

// Gera CEP com máscara
console.log(gerar.cep(true));

// Gera CEP para estado específico
console.log(gerar.cep(false, 'SP'));
console.log(gerar.cep(true, 'SP'));

/* ******************** CERTIDÕES ********************* */
// Gera certidão aleatória
console.log(gerar.certidao.aleatoria());
console.log(gerar.certidao.aleatoria(false));

// Gera certidão de nascimento
console.log(gerar.certidao.nascimento());
console.log(gerar.certidao.nascimento(false));

// Gera certidão de casamento
console.log(gerar.certidao.casamento());
console.log(gerar.certidao.casamento(false));

// Gera certidão de óbito
console.log(gerar.certidao.obito());
console.log(gerar.certidao.obito(false));

// Gera objetos detalhados de certidões
console.log(gerar.certidao.aleatoriaObj());
console.log(gerar.certidao.nascimentoObj());
console.log(gerar.certidao.casamentoObj());
console.log(gerar.certidao.obitoObj());

/* ******************** CNH *************************** */
// Gera CNH aleatória
console.log(gerar.cnh());

// Gera categoria CNH
console.log(gerar.cnhCategoria());

/* ******************** CNPJ ************************** */
// Gera CNPJ sem máscara
console.log(gerar.cnpj());

// Gera CNPJ com máscara
console.log(gerar.cnpj(true));

// Gera CNPJ Alfanumérico com máscara
console.log(gerar.cnpjAlfanumerico(true));

// Gera CNPJ Alfanumérico sem máscara
console.log(gerar.cnpjAlfanumerico(false));

// Gera CNPJ Alfanumérico Usando a função de compatibilidade
console.log(gerar.cnpj());

/* ******************** CNS *************************** */
// Gera CNS sem máscara e tipo aleatório
console.log(gerar.cns());

// Gera CNS com configurações específicas
console.log(gerar.cns(false, 'beneficiario'));
console.log(gerar.cns(false, 'profissional'));
console.log(gerar.cns(true));
console.log(gerar.cns(true, 'beneficiario'));
console.log(gerar.cns(true, 'profissional'));

/* ******************** CÓDIGO DE OPERADORA *********** */
// Gera códigos de operadoras
console.log(gerar.codigoOperadora());
console.log(gerar.codigoOperadora('Claro'));
console.log(gerar.codigoOperadora('Oi'));
console.log(gerar.codigoOperadora('Tim'));
console.log(gerar.codigoOperadora('Vivo'));
console.log(gerar.codigoOperadora('blablabla'));

/* ******************** CONTA BANCÁRIA *************** */
// Gera conta bancária aleatória
console.log(gerar.contaBancaria());

// Gera conta para bancos específicos
console.log(gerar.contaBancaria('Banco do Brasil'));
console.log(gerar.contaBancaria('Bradesco'));
console.log(gerar.contaBancaria('Caixa'));
console.log(gerar.contaBancaria('Citibank'));
console.log(gerar.contaBancaria('HSBC'));
console.log(gerar.contaBancaria('Itaú'));
console.log(gerar.contaBancaria('Santander'));

/* ******************** CPF ************************** */
// Gera CPF sem máscara
console.log(gerar.cpf());

// Gera CPF com máscara
console.log(gerar.cpf(true));

// Gera CPF para estados específicos
console.log(gerar.cpf(true, 'RS'));
console.log(gerar.cpf(false, 'MG'));

/* ******************** COR DA PELE *************** */
// Gera cor de pele aleatória
console.log(gerar.corPele());

// Gera tipo sanguíneo aleatório
console.log(gerar.tipoSanguineo());

/* ******************** DATAS *********************** */
// Gera data de nascimento aleatória
console.log(gerar.dataNascimento());

/* ******************** DDD ************************ */
// Gera DDD aleatório
console.log(gerar.ddd());

// Gera DDD para estado específico
console.log(gerar.ddd('SP'));

/* ******************** E-MAIL ********************* */
// Gera e-mail aleatório
console.log(gerar.email());

/* ******************** ENDEREÇO ******************* */
// Gera endereço completo
console.log(gerar.endereco());

// Gera endereço com CEP mascarado
console.log(gerar.endereco(true));

// Gera endereço para estado específico
console.log(gerar.endereco(false, "SP"));
console.log(gerar.endereco(true, "SP"));

/* ******************** ESCOLARIDADE *************** */
// Gera escolaridade aleatória
console.log(gerar.escolaridade());

/* ******************** Gênero *************** */
// Gera gênero aleatório
console.log(gerar.genero('f'));
console.log(gerar.genero('m'));
console.log(gerar.genero('i'));
console.log(gerar.genero());
console.log(gerar.genero(null));
console.log(gerar.genero('x'));

/* ****ORIENTAÇÃO SEXUAL E IDENTIDADE DE GÊNERO ******* */
console.log(gerar.orientacaoSexual());
console.log(gerar.identidadeGenero());
console.log(gerar.identidadePorOrientacao());

/* ******************** INSCRIÇÃO ESTADUAL ******** */
// Gera IE aleatória
console.log(gerar.inscricaoEstadual());

// Gera IE para estado específico
console.log(gerar.inscricaoEstadual('SP'));

/* ******************** NOMES ********************* */
// Gera vários tipos de nomes
console.log(gerar.nome.aleatorio());
console.log(gerar.nome.aleatorioCompleto());
console.log(gerar.nome.doMeio());
console.log(gerar.nome.feminino());
console.log(gerar.nome.femininoCompleto());
console.log(gerar.nome.mae());
console.log(gerar.nome.maeCompleto());
console.log(gerar.nome.masculino());
console.log(gerar.nome.masculinoCompleto());
console.log(gerar.nome.pai());
console.log(gerar.nome.paiCompleto());
console.log(gerar.nome.sobrenome());

/* ******************** NOME EMPRESA ********************* */
// Gera nome de empresa Baseado em filmes, séries, livros, videogames. animação, hq, etc.
console.log(gerar.nomeEmpresa())
console.log(gerar.nomeEmpresa("BR"))

/* ******************** PASSAPORTE ************** */
// Gera passaporte aleatório
console.log(gerar.passaporte());

/* ******************** PIS *********************** */
// Gera PIS sem máscara
console.log(gerar.pis());

// Gera PIS com máscara
console.log(gerar.pis(true));

/* ******************** PLACAS DE VEÍCULOS ******* */
// Gera placa no formato antigo
console.log(gerar.placaAntiga());
console.log(gerar.placaAntiga(true));

// Gera placa no formato Mercosul
console.log(gerar.placaMercosul());
console.log(gerar.placaMercosul(true));

/* ******************** PROFISSÃO **************** */
// Gera profissão aleatória
console.log(gerar.profissao());

/* ******************** PROVEDOR DE E-MAIL ******* */
// Gera provedor de e-mail aleatório
console.log(gerar.provedorEmail());

/* ******************** RENAVAM ****************** */
// Gera RENAVAM aleatório
console.log(gerar.renavam());

/* ******************** RG *********************** */
// Gera RG sem máscara
console.log(gerar.rg());

// Gera RG com máscara
console.log(gerar.rg(true));

/* ******************** TELEFONE **************** */
// Gera telefone sem máscara
console.log(gerar.telefone());

// Gera telefone com máscara
console.log(gerar.telefone(true));

// Gera telefone para estado específico
console.log(gerar.telefone(false, "RJ"));
console.log(gerar.telefone(true, "RJ"));

/* ******************** TEXTO ******************* */
// Gera texto aleatório
console.log(gerar.palavra());
console.log(gerar.sentenca());
console.log(gerar.sentenca(10));
console.log(gerar.paragrafo());
console.log(gerar.paragrafo(3));
console.log(gerar.paragrafo(3, 8));

/* ******************** TÍTULO DE ELEITOR ******* */
// Gera título de eleitor
console.log(gerar.tituloEleitor());
console.log(gerar.tituloEleitor(true));
console.log(gerar.tituloEleitor(true, 'SE'));
console.log(gerar.tituloEleitor(false, 'PR'));

Compatibilidade

O pacote foi testado e é compatível com as versões mais recentes dos seguinte frameworks:

Cypress Jest Node.js Test Runner Jasmine Playwright Mocha Chai Supertest Puppeteer Sinon

Contribuições

Contribuições são bem-vindas! Faça um fork do repositório e sinta-se à vontade para enviar seus pull requests.

Demo

Essas funções foram utilizadas nas seguintes aplicações:

Extensão Chrome - Gerador de Dados Fictícios - Muito útil para preencher automaticamente os campos de formulários em testes manuais.

Gerador-BR - Gerador de dados on-line.

License

FOSSA Status


Código de CondutaLicença MITSegurançaChangelogFórum

changelog

Registro de Alterações

Todas as mudanças notáveis neste projeto serão documentadas neste arquivo.


1.2.3 (2025-05-13)

Adiciona Funcionalidade

  • Gerador de Nome de Empresa

1.2.2 (2025-05-08)

Adiciona Funcionalidades

  • Gerador de Gênero
  • Gerador de Orientação Sexual
  • Gerador de Identidade de Gênero

1.2.1 (2025-05-06)

Adiciona Funcionalidade

  • Adiciona Recursos para Typescript

1.2.0 (2025-05-03)

Adiciona Funcionalidade

  • Gerador de CNPJ Alfanumérico

Refatora funcionalidades

  • Converte a chamada de todos os geradores para função

1.1.3 (2025-02-04)

Adiciona recurso

  • Adiciona types para typescript

1.1.1 (2024-11-13)

Adiciona Funcionalidades

  • Gerador de Certidão (Nascimento, Casamento e Óbito)

1.1.0 (2024-10-18)

Adiciona Dependência

  • Adicionado Rollup como ferramenta de build para empacotamento do projeto.
  • Configurado Rollup para gerar builds nos formatos CommonJS e ESModule.
  • Melhorado o processo de build para melhor performance e compatibilidade com diferentes sistemas de módulos.

1.0.6 (2024-10-09)

Adiciona Funcionalidades

  • Gerador de Escolaridade
  • Gerador de Profissão

1.0.5 (2024-10-06)

Adiciona Funcionalidades

  • Gerador de Inscrição Estadual

1.0.4 (2024-09-30)

Adiciona Funcionalidades

  • Gerador de Texto

1.0.3 (2024-08-22)

Adiciona Funcionalidades

  • Gerador de Banco
  • Gerador de Conta Bancária

1.0.2 (2024-08-15)

Adiciona Funcionalidades

  • Gerador de Cartão de Crédito
  • Gerador de Celular
  • Gerador de Telefone

Adiciona Arquivos

  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
  • LICENSE.md

1.0.1 (2024-08-13)

Adiciona Funcionalidades

  • Gerador de DDD
  • Gerador de Operadoras
  • Gerador de CEP

1.0.0 (2024-08-11)

Adiciona Funcionalidades

  • Gerador de CPF
  • Gerador de CNPJ
  • Gerador de RG
  • Gerador de CNH
  • Gerador de Categoria CNH
  • Gerador de PIS
  • Gerador de Passaporte
  • Gerador de Título de Eleitor
  • Gerador de CNS (Cartão Nacional Saúde)
  • Gerador de Nomes/Apelidos
  • Gerador de Gênero
  • Gerador de Endereço
  • Gerador de E-mail
  • Gerador de Data de Nascimento
  • Gerador de RENAVAM
  • Gerador de Placa veicular

Adiciona Arquivos de Dados

  • db-bancos.js
  • db-cep.js
  • db-general

Construção do pacote

  • arquivos:
    • index.js, index-teste.js, readme.md,
    • .gitignore, .eslintrc, .editorconig e .vscode.settings.json
  • dependências:
    • eslint, eslint-config-airbnb-base e eslint-plugin-import