Installations
npm install gerador-br
Developer Guide
Typescript
No
Module System
ESM
Node Version
20.3.1
NPM Version
9.8.1
Releases
Unable to fetch releases
Contributors
Unable to fetch Contributors
Languages
JavaScript (100%)
Developer
Download Statistics
Total Downloads
2,346
Last Day
5
Last Week
83
Last Month
291
Last Year
2,346
GitHub Statistics
7 Stars
182 Commits
4 Forks
1 Watching
5 Branches
4 Contributors
Bundle Size
185.06 kB
Minified
53.06 kB
Minified + Gzipped
Package Meta Information
Latest Version
1.1.2
Package Id
gerador-br@1.1.2
Unpacked Size
676.58 kB
Size
150.50 kB
File Count
63
NPM Version
9.8.1
Node Version
20.3.1
Publised On
15 Jan 2025
Total Downloads
Cumulative downloads
Total Downloads
2,346
Last day
-83.3%
5
Compared to previous day
Last week
-13.5%
83
Compared to previous week
Last month
110.9%
291
Compared to previous month
Last year
0%
2,346
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
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
1npm install gerador-br
Importação
ES Module
1import gerar from 'gerador-br';
CommonsJS
1const gerar = require('gerador-br');
Utilização
Veja todos os exemplos na documentação.
Importe apenas a(s) função(ões) que desejar:
1import { nome, cpf, cnpj, placaMercosul } from 'gerador-br'; // ES Module 2// const { nome, cpf, cnpj, placaMercosul } = require('gerador-br'); // CommonJS 3 4console.log(nome.femininoCompleto()); 5console.log(cpf()); 6console.log(cnpj()); 7console.log(placaMercosul());
Ou, importe todo o módulo gerar
e depois use qualquer função que desejar:
1import gerar from 'gerador-br'; // ES Module: 2// const gerar = require('gerador-br'); // CommonJS: 3 4console.log(gerar.nome.femininoCompleto()); 5console.log(gerar.cpf()); 6console.log(gerar.cnpj(); 7console.log(gerar.contaBancaria()); 8console.log(gerar.cartaoCredito());
Outros exemplos:
1import gerar from 'gerador-br'; // ES Module: 2// const gerar = require('gerador-br'); // CommonJS: 3 4/* ******************** DOCUMENTOS ********************** */ 5// Gera CNH aleatória 6console.log(gerar.cnh()); 7 8// Gera Categoria CNH 9console.log(gerar.cnhCategoria()); 10 11// Gera CNPJ sem máscara 12console.log(gerar.cnpj()); 13 14// Gera CNPJ com máscara 15console.log(gerar.cnpj(true)); 16 17// Gera CPF sem máscara e de estado aleatório 18console.log(gerar.cpf()); 19 20// Gera CPF com máscara e de estado aleatório 21console.log(gerar.cpf(true)); 22 23 // Gera CPF com máscara e do estado informado 24console.log(gerar.cpf(true, "RS")); 25 26// Gera CPF sem máscara e do estado informado 27console.log(gerar.cpf(false, "MG")); 28 29// Gera RG sem máscara 30console.log(gerar.rg()); 31 32// Gera RG com máscara 33console.log(gerar.rg(true)); 34 35// Gera CNS (Cartão Nacional Saúde) sem máscara e tipo aleatório 36console.log(gerar.cns()); 37 38// Gera CNS (Cartão Nacional Saúde) sem máscara e do tipo informado 39console.log(gerar.cns(false, 'beneficiario')); 40console.log(gerar.cns(false, 'profissional')); 41 42// Gera CNS (Cartão Nacional Saúde) com máscara e tipo aleatório 43console.log(gerar.cns(true)); 44 45// Gera CNS (Cartão Nacional Saúde) com máscara e do tipo informado 46console.log(gerar.cns(true, 'beneficiario')); 47console.log(gerar.cns(true, 'profissional')); 48 49// Gera PIS sem máscara 50console.log(gerar.pis()); 51 52// Gera PIS com máscara 53console.log(gerar.pis(true)); 54 55// Gera Título de Eleitor sem máscara e de estado aleatório 56console.log(gerar.tituloEleitor()); 57 58// Gera Título de Eleitor com máscara e de estado aleatório 59console.log(gerar.tituloEleitor(true)); 60 61// Gera Título de Eleitor sem máscara e de estado informado 62console.log(gerar.tituloEleitor(true,'SE')); 63 64// Gera Título de Eleitor com máscara e de estado informado 65console.log(gerar.tituloEleitor(false,'PR')); 66 67// Gera Passaporte aleatório 68console.log(gerar.passaporte()); 69 70// Gera uma Certidão (Nascimento, Casamento e Óbito) 71// Certidão aleatória 72console.log(gerar.certidao.aleatoria()); // com máscara 73console.log(gerar.certidao.aleatoria(false)); // sem máscara 74 75// Certidão de nascimento 76console.log(gerar.certidao.nascimento()); // com máscara 77console.log(gerar.certidao.nascimento(false)); // sem máscara 78 79// Certidão de casamento 80console.log(gerar.certidao.casamento()); // com máscara 81console.log(gerar.certidao.casamento(false)); // sem máscara 82 83// Certidão de óbito 84console.log(gerar.certidao.obito()); // com máscara 85console.log(gerar.certidao.obito(false)); // sem máscara 86 87// Objeto com os detalhes de Certidão 88console.log(gerar.certidao.aleatoriaObj()); // Objeto detalhado de certidão aleatória 89console.log(gerar.certidao.nascimentoObj()); // Objeto detalhado de certidão de nascimento 90console.log(gerar.certidao.casamentoObj()); // Objeto detalhado de certidão de casamento 91console.log(gerar.certidao.obitoObj()); // Objeto detalhado de certidão de óbito 92 93// Gera Inscrição Estadual aleatório e do estado informado. 94console.log('Sem informar o estado', gerar.inscricaoEstadual()); 95console.log('AC', gerar.inscricaoEstadual('AC')); // AC 01.335116638 96console.log('AP', gerar.inscricaoEstadual('AP')); // AP 03.42773842 97console.log('BA', gerar.inscricaoEstadual('BA')); // BA 16408652-16 98console.log('DF', gerar.inscricaoEstadual('DF')); // DF 0724.4814180 99console.log('RJ', gerar.inscricaoEstadual('RJ')); // RJ 41038311.44 100 101/* ******************** BANCOS ************************** */ 102// Gera dados de um banco aleatório 103console.log(gerar.banco()); 104 105// Opcionalmente, atribua o objeto a uma variável e utilize as propriedades 106const bnc = gerar.banco(); 107console.log(bnc.codigoBanco); 108console.log(bnc.nomeBanco); 109console.log(bnc.razaoSocial); 110console.log(bnc.ispb); 111 112// Gera dados do banco informado 113console.log(gerar.banco(237)); 114 115// Retorna uma lista de códigos de bancos 116console.log(gerar.listaCodigosBancos()); 117 118 119/* ******************** CARTÃO DE CRÉDITO *************** */ 120// Gera objeto cartaoCredito com as propriedades: 121// numero (sem máscara), bandeira, cvv, dataExpiracao e nomeTitular aleatório (abreviado) 122console.log(gerar.cartaoCredito()); 123 124// Opcionalmente, atribua o objeto a uma variável e utilize as propriedades 125const cc = gerar.cartaoCredito(); 126console.log(cc.numero); 127console.log(cc.bandeira); 128console.log(cc.cvv); 129console.log(cc.dataExpiracao); 130console.log(cc.nomeTitular); 131 132// Gera objeto cartaoCredito com as propriedades: 133// numero (com máscara), bandeira, cvv, dataExpiracao e nomeTitular informado (abreviado) 134console.log(gerar.cartaoCredito(true, "João Santos da Silva")); 135 136// Gera objeto cartaoCredito com as propriedades: 137// numero (sem máscara), bandeira, cvv, dataExpiracao e nomeTitular informado (abreviado) 138console.log(gerar.cartaoCredito(false, "Maria Aparecida Reis")); 139 140// Gera objeto cartaoCredito com as propriedades: 141// numero (com máscara), bandeira, cvv, dataExpiracao e nomeTitular gerado (abreviado) 142console.log(gerar.cartaoCredito(true, gerar.nome.femininoCompleto())); 143 144 145/* ******************** CONTA BANCÁRIA ****************** */ 146// Gera uma conta bancária aleatória de um banco aleatório 147console.log(gerar.contaBancaria()); 148 149// Opcionalmente, atribua o objeto a uma variável e utilize as propriedades 150const cb = gerar.contaBancaria(); 151console.log(cb.codigoBanco); 152console.log(cb.nomeBanco); 153console.log(cb.agencia); 154console.log(cb.agenciaDv); 155console.log(cb.conta); 156console.log(cb.contaDv); 157 158// Gera uma conta bancária aleatória do Banco do Brasil 159console.log(gerar.contaBancaria('1')); 160console.log(gerar.contaBancaria('Banco do Brasil')); 161 162// Gera uma conta bancária aleatória do Bradesco 163console.log(gerar.contaBancaria("237")); 164console.log(gerar.contaBancaria('Bradesco')); 165 166// Gera uma conta bancária aleatória da Caixa 167console.log(gerar.contaBancaria('104')); 168console.log(gerar.contaBancaria('Caixa')); 169 170// Gera uma conta bancária aleatória do Citibank 171console.log(gerar.contaBancaria('745')); 172console.log(gerar.contaBancaria('Citibank')); 173 174// Gera uma conta bancária aleatória do HSBC 175console.log(gerar.contaBancaria('296')); 176console.log(gerar.contaBancaria('HSBC')); 177 178// Gera uma conta bancária aleatória do Itaú 179console.log(gerar.contaBancaria('341')); 180console.log(gerar.contaBancaria('Itaú')); 181 182// Gera uma conta bancária aleatória do Santander 183console.log(gerar.contaBancaria('33')); 184console.log(gerar.contaBancaria('Santander')); 185 186 187/* ******************** NOME **************************** */ 188// Gera um nome aleatório (feminino ou masculino) 189console.log(gerar.nome.aleatorio()); 190 191// Gera um nome aleatório completo (feminino ou masculino) 192console.log(gerar.nome.aleatorioCompleto()); 193 194// Gera um nome masculino aleatório 195console.log(gerar.nome.masculino()); 196 197// Gera um nome masculino completo aleatório 198console.log(gerar.nome.masculinoCompleto()); 199 200// Gera um nome feminino aleatório 201console.log(gerar.nome.feminino()); 202 203// Gera um nome feminino completo aleatório 204console.log(gerar.nome.femininoCompleto()); 205 206// Gera o nome da mãe aleatório 207console.log(gerar.nome.mae()); 208 209// Gera o nome completo da mãe aleatório 210console.log(gerar.nome.maeCompleto()); 211 212// Gera o nome do pai aleatório 213console.log(gerar.nome.pai()); 214 215// Gera o nome completo do pai aleatório 216console.log(gerar.nome.paiCompleto()); 217 218// Gera um nome do meio aleatório 219console.log(gerar.nome.doMeio()); 220 221// Gera um sobrenome aleatório 222console.log(gerar.nome.sobrenome()); 223 224// Gera apelido aleatório 225console.log(gerar.apelido()); 226 227 228/* ******************** DATAS *************************** */ 229// Gera data de nascimento aleatória 230console.log(gerar.dataNascimento()); 231 232 233/* ******************** E-MAIL ************************** */ 234// Gera e-mail com nickname aleatório 235console.log(gerar.email()); 236 237// Gera e-mail com nome masculino 238const nomeMasculinoCompleto =gerar.nome.masculinoCompleto(); 239console.log(gerar.email(nomeMasculinoCompleto)); 240 241// Gera e-mail com nome feminino 242const nomeFemininoCompleto = gerar.nome.femininoCompleto(); 243console.log(gerar.email(nomeFemininoCompleto)); 244 245/* ******************** ESCOLARIDADE ******************** */ 246// Gera escolaridade 247console.log(gerar.escolaridade()); 248 249/* ******************** PROFISSÃO *********************** */ 250// Gera profissão 251console.log(gerar.profissao()); 252 253/* ******************** DDD ***************************** */ 254 // Gera DDD aleatório 255console.log(gerar.ddd()); 256 257// Gera DDD aleatório do estado informado 258console.log(gerar.ddd("PA")); 259 260 261/* ******************** CÓDIGO DE OPERADORA ************** */ 262// ATENÇAO: Devido a portabilidade, celulares reais podem não pertencer mais a operadora de origem 263 264// Gera um código da Claro (968, 973, 974, 975, 976, 991, 992, 993 ou 994) 265console.log(gerar.codigoOperadora("Claro")); 266 267// Gera um código da Oi (984, 985, 986, 987, 988 ou 989) 268console.log(gerar.codigoOperadora("Oi")); 269 270// Gera um código da Tim (969, 979, 980, 981, 982 ou 983) 271console.log(gerar.codigoOperadora("Tim")); 272 273// Gera um código da Vivo (967, 971, 972, 995, 996, 997, 998 ou 999) 274console.log(gerar.codigoOperadora("Vivo")); 275 276// Gera um código de uma operadora aleatória 277console.log(gerar.codigoOperadora()); 278 279// Gera um código de uma operadora aleatória 280console.log(gerar.codigoOperadora("blablabla")); 281 282 283/* ******************** CELULAR ************************* */ 284// Gera celular sem máscara, de estado aleatório e operadora aleatória 285console.log(gerar.celular()); // "11999999999" 286 287// Gera celular com máscara, de estado aleatório e operadora aleatória 288console.log(gerar.celular(true)); // "(11) 99999-9999" 289 290// Gera celular sem máscara, do estado informado e operadora aleatória 291console.log(gerar.celular(false, "SC")); // "48999999999" 292 293// Gera celular com máscara, do estado informado e operadora aleatória 294console.log(gerar.celular(true, "ES")); // "(27) 99999-9999" 295 296// Gera celular sem máscara, do estado aleatório e operadora informada 297console.log(gerar.celular(false, "", "Claro")); // "85991999999" 298 299// Gera celular com máscara, do estado informado e operadora aleatória 300console.log(gerar.celular(true, "MS", "Vivo")); // "(67) 99799-9999" 301 302 303/* ******************** CELULAR ************************* */ 304// Gera telefone sem máscara, de estado aleatório 305console.log(gerar.telefone()); // "1199999999" 306 307// Gera telefone com máscara, de estado aleatório 308console.log(gerar.telefone(true)); // "(11) 9999-9999" 309 310// Gera telefone sem máscara, do estado informado 311console.log(gerar.telefone(false, "SC")); // "4899999999" 312 313// Gera telefone com máscara, do estado informado 314console.log(gerar.telefone(true, "ES")); // "(27) 9999-9999" 315 316 317/* ******************** SOBRE A PESSOA ****************** */ 318// Gera cor de pele aleatória 319console.log(gerar.corPele()); 320 321// Gera tipo sanguíneo aleatório 322console.log(gerar.tipoSanguineo()); 323 324 325/* ******************** CEP *************************** */ 326// Gera CEP sem máscara de estado aleatório 327console.log(gerar.cep()); // "12345678" 328 329// Gera CEP com máscara de estado aleatório 330console.log(gerar.cep(true)); // "12345-678" 331 332// Gera CEP sem máscara de estado informado 333console.log(gerar.cep(false, "SP")); // "01001000" 334 335// Gera CEP com máscara de estado informado 336console.log(gerar.cep(true, "SP")); // "01001-000" 337 338 339/* ******************** ENDEREÇO ************************ */ 340// Gera um objeto com todos os campos do endereço e de estado aleatório 341console.log(gerar.endereco()); 342 343// Gera um objeto com todos os campos do endereço, o CEP com máscara e de estado aleatório 344console.log(gerar.endereco(true)); 345 346// Gera um objeto com todos os campos do endereço, o CEP sem máscara e de estado aleatório 347console.log(gerar.endereco(false)); 348 349// Gera um objeto com todos os campos do endereço, o CEP com máscara e do estado informado 350console.log(gerar.endereco(true, "RJ")); 351 352// Gera um objeto com todos os campos do endereço, o CEP sem máscara e do estado informado 353console.log(gerar.endereco(false, "SP")); 354 355 356// Opcionalmente, gere um endereço e utilize apenas a propriedade desejada 357const enderecoGerado = gerar.endereco(); 358console.log(enderecoGerado.cep); 359console.log(enderecoGerado.logradouro); 360console.log(enderecoGerado.numero); 361console.log(enderecoGerado.complemento);// caso exista 362console.log(enderecoGerado.bairro); 363console.log(enderecoGerado.localidade); 364console.log(enderecoGerado.estado); 365 366 367/* ******************** VEÍCULO ************************* */ 368// Gera placa no formato antigo com máscara "ABC-1234" 369console.log(gerar.placaAntiga(true)); 370 371// Gera placa no formato antigo sem máscara "ABC1234" 372console.log(gerar.placaAntiga(false)); 373 374// Gera placa no formato Mercosul com máscara "ABC-1D23" 375console.log(gerar.placaMercosul(true)); 376 377// Gera placa no formato Mercosul sem máscara "ABC1D23" 378console.log(gerar.placaMercosul(false)); 379 380// Gera RENAVAM 381console.log(gerar.renavam()); 382 383/* ******************** TEXTO *************************** */ 384// Gera uma palavra aleatória 385console.log(gerar.palavra()); 386 387// Gera uma sentença com quantidade de palavras aleatórias 388console.log(gerar.sentenca()); 389 390// Gera uma sentença com quantidade de palavras definida 391console.log(gerar.sentenca(10)); 392 393// Gera um parágrafo com quantidade de palavras aleatórias 394console.log(gerar.paragrafo()); 395 396// Gera um parágrafo com quantidade de sentença informada, cada uma com quantidade de palavras aleatórias 397console.log(gerar.paragrafo(5)); 398 399// Gera um parágrafo com quantidade de sentenças e de palavras informadas. 400console.log(gerar.paragrafo(3,8));
Compatibilidade
O pacote foi testado e é compatível com as versões mais recentes dos seguinte frameworks:
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
Código de Conduta • Licença MIT • Segurança • Changelog • Fórum
No vulnerabilities found.
No security vulnerabilities found.
Other packages similar to gerador-br
documento-validacao-br
Pacote de validação de CPFs de forma rápida e simples
faker-br
Brazilian Faker Data Generator - Gerador de dados para o Brasil. Fork do faker para pt_BR com extensão para CNPJ, CPF, RG, etc.
br-document-utils
Gerador e Validador de documentos brasileiros
insomnia-plugin-documents-br
Gerador de documentos Brasileiro. (Nome | CPF | CNPJ | telefone | cep)