COMEÇANDO

Sobre o Gerador-BR

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:

Gerador de Documento: CPF, RG, CNH, Título de Eleitor, PIS, CNS (Cartão Nacional Saúde), Passaporte e Certidão (Nascimento, Casamento e Óbito)
Gerador de Pessoa: Nome, Nickname, Data de Nascimento, Cor de Pele, Orientação Sexual, Identidade de Gênero, Tipo Sanguíneo, Escolaridade e Profissão;
Gerador de Empresa: CNPJ e Inscrição Estadual;
Gerador de Endereço: CEP, Logradouro, Número, Bairro, Localidade e Estado;
Gerador de Contato: E-mail, DDD, Operadora, Celular e Telefone;
Gerador de Conta Bancária: Código do Banco, Nome do Banco, Agência Bancária e Conta Bancária;
Gerador de Cartão de Crédito: Número, Bandeira, CVV e Validade;
Gerador de Veículo: Placa Antiga, Placa Mercosul e RENAVAM;
Gerador de Texto (Lorem Ipsum): Palavras, Sentenças e Parágrafos;

Instalação


npm install gerador-br

Importação

ES Module:


import gerar from 'gerador-br';

CommonJS:


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

Utilizaçã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());

DOCUMENTOS PF

Exemplo de uso para geração de documentos de Pessoa Física.

CPF


import { cpf } from 'gerador-br'; // es module
// const { cpf } = require('gerador-br'); // commonjs

// gera cpf sem máscara e de estado aleatório
cpf();

// gera cpf com máscara e de estado aleatório
cpf(true);

// gera cpf com máscara e do estado informado
cpf(true, "rs");

// gera cpf sem máscara e do estado informado
cpf(false, "mg");

CNH


import { cnh, cnhCategoria } from 'gerador-br'; // ES Module
// const { cnh, cnhCategoria } = require('gerador-br'); // CommonJS

// Gera CNH aleatória
cnh();

// Gera Categoria CNH
cnhCategoria();

RG


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

// Gera RG sem máscara
rg();

// Gera RG com máscara
rg(true);

CNS


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

// Gera CNS (Cartão Nacional Saúde) sem máscara e tipo aleatório
cns();

// Gera CNS (Cartão Nacional Saúde) sem máscara e do tipo informado
cns(false, 'beneficiario');
cns(false, 'profissional');

// Gera CNS (Cartão Nacional Saúde) com máscara e tipo aleatório
cns(true);

// Gera CNS (Cartão Nacional Saúde) com máscara e do tipo informado
cns(true, 'beneficiario');
cns(true, 'profissional');

PIS


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

// Gera PIS sem máscara
pis();

// Gera PIS com máscara
pis(true);

Título de Eleitor


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

// Gera Título de Eleitor sem máscara e de estado aleatório
tituloEleitor();

// Gera Título de Eleitor com máscara e de estado aleatório
tituloEleitor(true);

// Gera Título de Eleitor sem máscara e de estado informado
tituloEleitor(true,'SE');

// Gera Título de Eleitor com máscara e de estado informado
tituloEleitor(false,'PR');

Passaporte


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

// Gera Passaporte aleatório
passaporte();

Certidão


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

// Certidão aleatória
certidao.aleatoria();        // com máscara
certidao.aleatoria(false);   // sem máscara

// Certidão de nascimento
certidao.nascimento();       // com máscara
certidao.nascimento(false);  // sem máscara

// Certidão de casamento
certidao.casamento();        // com máscara
certidao.casamento(false);   // sem máscara

// Certidão de óbito
certidao.obito();            // com máscara
certidao.obito(false);       // sem máscara

// Objeto com os detalhes de Certidão
certidao.aleatoriaObj();     // Objeto detalhado de certidão aleatória
certidao.nascimentoObj();    // Objeto detalhado de certidão de nascimento
certidao.casamentoObj();     // Objeto detalhado de certidão de casamento
certidao.obitoObj();         // Objeto detalhado de certidão de óbito

DOCUMENTOS PJ

Exemplo de uso para geração de documentos de Pessoa Jurídica.

CNPJ


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

// Gera CNPJ sem máscara
cnpj();

// Gera CNPJ com máscara
cnpj(true);

Inscrição Estadual


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

// Gera Inscrição Estadual aleatório e do estado informado.
inscricaoEstadual();      // Sem informar o estado
inscricaoEstadual('AC');  // AC 01.335116638
inscricaoEstadual('AP');  // AP 03.42773842
inscricaoEstadual('BA');  // BA 16408652-16
inscricaoEstadual('DF');  // DF 0724.4814180
inscricaoEstadual('RJ');  // RJ 41038311.44

BANCOS

Exemplos de uso para geração de dados bancários.

Banco


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

// Gera dados de um banco aleatório
banco();

// Opcionalmente, atribua o objeto a uma variável e utilize as propriedades
const bnc = banco();
console.log(bnc.codigoBanco);
console.log(bnc.nomeBanco);
console.log(bnc.razaoSocial);
console.log(bnc.ispb);

// Gera dados do banco informado
banco(237);

Lista de Códigos de Bancos


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

// Retorna uma lista de códigos de bancos
listaCodigosBancos();

Cartão de Crédito


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

// Gera objeto cartaoCredito com as propriedades:
// numero (sem máscara), bandeira, cvv, dataExpiracao e nomeTitular aleatório (abreviado)
cartaoCredito();

// Opcionalmente, atribua o objeto a uma variável e utilize as propriedades
const cc = cartaoCredito();
console.log(cc.numero);
console.log(cc.bandeira);
console.log(cc.cvv);
console.log(cc.dataExpiracao);
console.log(cc.nomeTitular);

// Gera objeto cartaoCredito com as propriedades:
// numero (com máscara), bandeira, cvv, dataExpiracao e nomeTitular informado (abreviado)
cartaoCredito(true, "João Santos da Silva");

// Gera objeto cartaoCredito com as propriedades:
// numero (sem máscara), bandeira, cvv, dataExpiracao e nomeTitular informado (abreviado)
cartaoCredito(false, "Maria Aparecida Reis");

// Gera objeto cartaoCredito com as propriedades:
// numero (com máscara), bandeira, cvv, dataExpiracao e nomeTitular gerado (abreviado)
cartaoCredito(true, nome.femininoCompleto());

Conta Bancária


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

// Gera uma conta bancária aleatória de um banco aleatório
contaBancaria();

// Opcionalmente, atribua o objeto a uma variável e utilize as propriedades
const cb = contaBancaria();
console.log(cb.codigoBanco);
console.log(cb.nomeBanco);
console.log(cb.agencia);
console.log(cb.agenciaDv);
console.log(cb.conta);
console.log(cb.contaDv);

// Gera uma conta bancária aleatória do Banco do Brasil
contaBancaria('1');
contaBancaria('Banco do Brasil');

// Gera uma conta bancária aleatória do Bradesco
contaBancaria("237");
contaBancaria('Bradesco');

// Gera uma conta bancária aleatória da Caixa
contaBancaria('104');
contaBancaria('Caixa');

// Gera uma conta bancária aleatória do Citibank
contaBancaria('745');
contaBancaria('Citibank');

// Gera uma conta bancária aleatória do HSBC
contaBancaria('296');
contaBancaria('HSBC');

// Gera uma conta bancária aleatória do Itaú
contaBancaria('341');
contaBancaria('Itaú');

// Gera uma conta bancária aleatória do Santander
contaBancaria('33');
contaBancaria('Santander');

PESSOAS

Exemplo de uso para geração de dados pessoais.

Nome


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

// Gera um nome aleatório (feminino ou masculino)
nome.aleatorio();

// Gera um nome aleatório completo (feminino ou masculino)
nome.aleatorioCompleto();

// Gera um nome masculino aleatório
nome.masculino();

// Gera um nome masculino completo aleatório
nome.masculinoCompleto();

// Gera um nome feminino aleatório
nome.feminino();

// Gera um nome feminino completo aleatório
nome.femininoCompleto();

// Gera o nome da mãe aleatório
nome.mae();

// Gera o nome completo da mãe aleatório
nome.maeCompleto();

// Gera o nome do pai aleatório
nome.pai();

// Gera o nome completo do pai aleatório
nome.paiCompleto();

// Gera um nome do meio aleatório
nome.doMeio();

// Gera um sobrenome aleatório
nome.sobrenome();

Apelido


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

// Gera apelido aleatório
apelido();

Data de Nascimento


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

// Gera data de nascimento aleatória
dataNascimento();

Escolaridade


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

// Gera escolaridade
escolaridade();

Profissão


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

// Gera profissão
profissao();

Cor da Pele


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

// Gera cor de pele aleatória
corPele();

Tipo Sanguíneo


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

// Gera tipo sanguíneo aleatório
tipoSanguineo();

CONTATOS

Exemplo de uso para geração de contato.

Email


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

// Gera e-mail com nickname aleatório
email();

// Gera e-mail com nome masculino
const nomeMasculinoCompleto = nome.masculinoCompleto();
email(nomeMasculinoCompleto);

// Gera e-mail com nome feminino
const nomeFemininoCompleto = nome.femininoCompleto();
email(nomeFemininoCompleto);

DDD


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

// Gera DDD aleatório
ddd();

// Gera DDD aleatório do estado informado
ddd("PA");

Código da Operadora

Nota:

Devido a portabilidade, celulares reais podem não pertencer mais a operadora de origem.


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

// Gera um código da Claro (968, 973, 974, 975, 976, 991, 992, 993 ou 994)
codigoOperadora("Claro");

// Gera um código da Oi (984, 985, 986, 987, 988 ou 989)
codigoOperadora("Oi");

// Gera um código da Tim (969, 979, 980, 981, 982 ou 983)
codigoOperadora("Tim");

// Gera um código da Vivo (967, 971, 972, 995, 996, 997, 998 ou 999)
codigoOperadora("Vivo");

// Gera um código de uma operadora aleatória
codigoOperadora();

// Gera um código de uma operadora aleatória
codigoOperadora("blablabla");

Celular


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

// Gera celular sem máscara, de estado aleatório e operadora aleatória
celular();                   // "11999999999"

// Gera celular com máscara, de estado aleatório e operadora aleatória
celular(true);               // "(11) 99999-9999"

// Gera celular sem máscara, do estado informado e operadora aleatória
celular(false, "SC");        // "48999999999"

// Gera celular com máscara, do estado informado e operadora aleatória
celular(true, "ES");         // "(27) 99999-9999"

// Gera celular sem máscara, do estado aleatório e operadora informada
celular(false, "", "Claro"); // "85991999999"

// Gera celular com máscara, do estado informado e operadora aleatória
celular(true, "MS", "Vivo"); // "(67) 99799-9999"

Telefone


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

// Gera telefone sem máscara, de estado aleatório
telefone();             // "1199999999"

// Gera telefone com máscara, de estado aleatório
telefone(true);         // "(11) 9999-9999"

// Gera telefone sem máscara, do estado informado
telefone(false, "SC");  // "4899999999"

// Gera telefone com máscara, do estado informado
telefone(true, "ES");   // "(27) 9999-9999"

CEP


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

// Gera CEP sem máscara de estado aleatório
cep();                  // "12345678"

// Gera CEP com máscara de estado aleatório
cep(true);              // "12345-678"

// Gera CEP sem máscara de estado informado
cep(false, "SP");       // "01001000"

// Gera CEP com máscara de estado informado
cep(true, "SP");        // "01001-000"

Endereço


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

// Gera um objeto com todos os campos do endereço e de estado aleatório
endereco();

// Gera um objeto com todos os campos do endereço, o CEP com máscara e de estado aleatório
endereco(true);

// Gera um objeto com todos os campos do endereço, o CEP sem máscara e de estado aleatório
endereco(false);

// Gera um objeto com todos os campos do endereço, o CEP com máscara e do estado informado
endereco(true, "RJ");

// Gera um objeto com todos os campos do endereço, o CEP sem máscara e do estado informado
endereco(false, "SP");

// Opcionalmente, gere um endereço e utilize apenas a propriedade desejada
const end = endereco();
console.log(end.cep);
console.log(end.logradouro);
console.log(end.numero);
console.log(end.complemento); // caso exista
console.log(end.bairro);
console.log(end.localidade);
console.log(end.estado);

VEÍCULOS

Exemplo de uso para geração de dados de veículos.

Placa Antiga


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

// Gera placa no formato antigo com máscara "ABC-1234"
placaAntiga(true);

// Gera placa no formato antigo sem máscara "ABC1234"
placaAntiga(false);

Placa Mercosul


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

// Gera placa no formato Mercosul com máscara "ABC-1D23"
placaMercosul(true);

// Gera placa no formato Mercosul sem máscara "ABC1D23"
placaMercosul(false);

RENAVAM


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

// Gera RENAVAM
renavam();

LOREM IPSUM

Exemplo de uso para geração de textos genéricos.

Palavra


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

// Gera uma palavra aleatória
palavra();

Sentença


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

// Gera uma sentença com quantidade de palavras aleatórias
sentenca();

// Gera uma sentença com quantidade de palavras definida
sentenca(10);

Parágrafo


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

// Gera um parágrafo com quantidade de palavras aleatórias
paragrafo();

// Gera um parágrafo com quantidade de sentença informada, cada uma com quantidade de palavras aleatórias
paragrafo(5);

// Gera um parágrafo com quantidade de sentenças e de palavras informadas.
paragrafo(3,8);