interface CertidaoDetalhes { tipoCertidao: string; cartorio: string; estado: string; anoRegistro: string; tipoLivro: string; tipoFolha: string; termo: string; folha: string; livro: string; } /** * Objeto `certidao` que fornece métodos para gerar números de certidões. */ declare const certidao: { aleatoria(mask?: boolean): string; nascimento(mask?: boolean): string; casamento(mask?: boolean): string; obito(mask?: boolean): string; aleatoriaObj(mask?: boolean): CertidaoDetalhes; nascimentoObj(mask?: boolean): CertidaoDetalhes; casamentoObj(mask?: boolean): CertidaoDetalhes; obitoObj(mask?: boolean): CertidaoDetalhes; }; /** * Gera um apelido fictício aleatório. * * @returns Um apelido gerado aleatoriamente. * @example * console.log(apelido()); // Exemplo: "Falcão", "Astronauta", "Relíquia" */ declare function apelido(): string; interface BancoData { codigoBanco: string; nomeBanco: string; razaoSocial: string; ispb: string; } /** * Gera dados de um banco aleatório. * * @param code - O código do banco. Se não for informado, um banco aleatório será gerado. * @returns Um objeto contendo os dados do banco. * @example * console.log(banco()); * console.log(banco(1)); */ declare function banco(code?: number | string): BancoData; /** * Retorna uma lista de códigos de bancos. * * @returns Uma lista de códigos de bancos. * @example * console.log(listaCodigosBancos()); */ declare function listaCodigosBancos(): number[]; interface CartaoCreditoData { numero: string; bandeira: string; cvv: string; dataExpiracao: string; nomeTitular: string; } /** * Gera Cartão de Crédito aleatório. * @param mask - Se `true`, o número do cartão será retornado com a máscara (xxxx xxxx xxxx xxxx). * @param fullTitularName - Nome completo do titular * @returns Um objeto contendo número do cartão, bandeira, CVV, data de expiração e nome do titular * @example * console.log(cartaoCredito()); * console.log(cartaoCredito(true, "João Santos da Silva")); */ declare function cartaoCredito(mask?: boolean, fullTitularName?: string): CartaoCreditoData; /** * Gera um número de celular aleatório. * * @param mask - Se `true`, o celular será retornado com a máscara. * @param state - A sigla do estado para filtrar os DDDs. * @param operator - O nome da operadora ("Claro", "Oi", "Tim", "Vivo"). * @returns O número de celular gerado. * @example * console.log(celular()); // "11999999999" * console.log(celular(true)); // "(11) 99999-9999" */ declare function celular(mask?: boolean, state?: string, operator?: string): string; /** * Gera um CEP aleatório. * * @param mask - Se `true`, o CEP será retornado com a máscara de formatação (xxxxx-xxx). * @param state - A sigla do estado para filtrar os CEPs. * @returns O CEP gerado. * @example * console.log(cep()); // "12345678" * console.log(cep(true, "SP")); // "01001-000" */ declare function cep(mask?: boolean, state?: string): string; /** * Gera um número de CNH aleatório. * * @returns O número de CNH gerado. * @example * console.log(cnh()); // "12345678901" */ declare function cnh(): string; /** * Uma categoria de CNH aleatória. * @returns Uma categoria de CNH gerada aleatoriamente. * @example * console.log(cnhCategoria()); // Exemplo: "A", "B", "C", etc. */ declare function cnhCategoria(): string; /** * Gera um número de CNPJ tradicional (apenas numérico) aleatório. * * @param mask - Se `true`, o CNPJ será retornado com a máscara de formatação (xx.xxx.xxx/0001-xx). * @returns O CNPJ gerado. * @example * console.log(cnpj(true)); // "12.345.678/0001-00" * console.log(cnpj(false)); // "12345678000100" */ declare function cnpj(mask?: boolean): string; /** * Gera um CNPJ alfanumérico válido. * @param masked - Se true, retorna com máscara de formatação (XX.XXX.XXX/XXXX-XX). * @returns CNPJ gerado. */ declare function cnpjAlfanumerico(masked?: boolean): string; /** * Gera um número de Cartão Nacional de Saúde (CNS) aleatório. * @param mask - Se true, retorna o CNS com máscara (XXX XXXX XXXX XXXX). * @param type - O tipo de CNS a ser gerado ('beneficiario' ou 'profissional'). * @returns O número de CNS gerado. * @example * console.log(cns()); * console.log(cns(true, 'beneficiario')); */ declare function cns(mask?: boolean, type?: 'beneficiario' | 'profissional' | string): string; interface ContaBancariaData { codigoBanco: string; nomeBanco: string; agencia: string; agenciaDv: string; conta: string; contaDv: string; } /** * Gera uma conta bancária aleatória. * * @param bank - O nome ou código do banco para gerar a conta. * @returns Um objeto contendo dados de agência, conta e banco. * @example * console.log(contaBancaria('1')); * console.log(contaBancaria('Bradesco')); */ declare function contaBancaria(bank?: string): ContaBancariaData; /** * Gera uma cor de pele aleatória. * @returns Uma cor de pele gerada aleatoriamente. * @example * console.log(corPele()); // Exemplo: "Branca", "Preta", "Parda", "Amarela", "Outro" */ declare function corPele(): string; /** * Gera um número de CPF aleatório. * @param mask - Se `true`, o CPF será retornado com a máscara (xxx.xxx.xxx-xx). * @param state - A sigla do estado para determinar a origem do CPF. * @returns O CPF gerado. * @example * console.log(cpf(true, "SP")); // "123.456.789-09" */ declare function cpf(mask?: boolean, state?: string): string; /** * Gera uma data de nascimento aleatória com base nos parâmetros fornecidos. * * @param ageOrRange - Idade específica ou intervalo [idadeMin, idadeMax] * @returns Data de nascimento no formato DD/MM/YYYY * @example * console.log(dataNascimento()); // Data entre 18-80 anos * console.log(dataNascimento(25)); // Data de quem tem 25 anos * console.log(dataNascimento([30, 40])); // Data entre 30-40 anos */ declare function dataNascimento(ageOrRange?: number | [number, number]): string; /** * Gera um DDD aleatório para um estado brasileiro. * * @param state - A sigla do estado (por exemplo, "SP", "RJ"). * @returns O DDD aleatório para o estado fornecido. * @example * console.log(ddd("SP")); */ declare function ddd(state?: string): string; /** * Gera um endereço de e-mail aleatório. * * @param fullName - O nome completo a ser usado para gerar o e-mail. * @returns O endereço de e-mail gerado. * @example * console.log(email()); * console.log(email("José Maria")); */ declare function email(fullName?: string): string; interface EnderecoData { cep: string; logradouro: string; numero: string; complemento: string; bairro: string; localidade: string; estado: string; } /** * Gera um endereço aleatório. * * @param mask - Se `true`, o CEP será retornado com a máscara de formatação (xxxxx-xxx). * @param state - A sigla do estado para filtrar os CEPs. * @returns O objeto de endereço gerado. * @example * console.log(endereco()); * console.log(endereco(true, "SP")); */ declare function endereco(mask?: boolean, state?: string): EnderecoData; /** * Gera uma escolaridade fictícia aleatória. * @returns Uma escolaridade gerada aleatoriamente. * @example * console.log(escolaridade()); // Exemplo: "Ensino Médio Completo", "Superior Completo", etc. */ declare function escolaridade(): string; /** * Retorna a descrição do gênero com base na sigla fornecida. * * @param input - Sigla do gênero. Valores aceitos: 'm', 'f', 'i'. * @returns A descrição do gênero correspondente. * @example * console.log(genero('f')); // "Feminino" * console.log(genero('m')); // "Masculino" * console.log(genero('i')); // "Intersexo" * console.log(genero()); // "Masculino" ou "Feminino" */ declare function genero(input?: string | null | any): string; /** * Uma identidade de gênero aleatória. * @returns Uma identidade de gênero gerada aleatoriamente. * @example * console.log(identidadeGenero()); // Exemplo: "Cisgênero", "Transgênero", "Não binário" */ declare function identidadeGenero(): string; /** * Gera uma identidade de gênero associada à orientação sexual selecionada. * * @param orientacaoSexual - A orientação sexual a ser associada à identidade de gênero. * @returns Uma identidade de gênero associada à orientação sexual fornecida ou aleatória. * @example * console.log(identidadePorOrientacao('Heterossexual')); */ declare function identidadePorOrientacao(orientacaoSexual?: string): string; /** * Gera Inscrição Estadual aleatório e do estado informado. * * @param state A sigla do estado para o qual gerar a inscrição estadual. * @returns O número de inscrição estadual gerado. * @example * console.log(inscricaoEstadual()); * console.log(inscricaoEstadual('AC')); */ declare function inscricaoEstadual(state?: string): string; /** * Objeto com geradores de nomes aleatórios. */ declare const nome: { /** * Um nome aleatório (masculino ou feminino). */ aleatorio(): string; /** * Um nome aleatório completo. */ aleatorioCompleto(): string; /** * Um nome masculino aleatório. */ masculino(): string; /** * Um nome masculino completo aleatório. */ masculinoCompleto(): string; /** * Um nome feminino aleatório. */ feminino(): string; /** * Um nome feminino completo aleatório. */ femininoCompleto(): string; /** * Um nome da mãe aleatório. */ mae(): string; /** * Um nome completo da mãe aleatório. */ maeCompleto(): string; /** * Um nome do pai aleatório. */ pai(): string; /** * Um nome completo do pai aleatório. */ paiCompleto(): string; /** * Um nome do meio aleatório. */ doMeio(): string; /** * Um sobrenome aleatório. */ sobrenome(): string; }; /** * Gera um nome de empresa aleatório. Baseado em filmes, séries, livros, videogames, animação, hq, etc. * * @param local - Se for 'BR' ou 'br', retorna apenas empresas brasileiras. * @returns Um nome de empresa. * @example * console.log(nomeEmpresa()); * console.log(nomeEmpresa('BR')); */ declare function nomeEmpresa(local?: string): string; /** * Gera um código de operadora de celular aleatório. * * @param name - O nome da operadora (por exemplo, "Claro", "Oi", "Tim", "Vivo"). * @returns O código de operadora gerado. * @example * console.log(codigoOperadora("Claro")); */ declare function codigoOperadora(name?: string): number; /** * Gera uma orientação sexual aleatória. * @returns Uma orientação sexual gerada aleatoriamente. * @example * console.log(orientacaoSexual()); // Exemplo: "Heterossexual", "Homossexual", etc. */ declare function orientacaoSexual(): string; /** * Gera um número de Passaporte aleatório. * * @returns O número de Passaporte gerado. * @example * console.log(passaporte()); // "AB1234567" */ declare function passaporte(): string; /** * Gera um número de PIS aleatório. * * @param mask - Se `true`, o PIS será retornado com a máscara de formatação (xxx.xxxxx.xx.x). * @returns O número de PIS gerado. * @example * console.log(pis()); // "68677229185" * console.log(pis(true)); // "686.77229.18.5" */ declare function pis(mask?: boolean): string; /** * Gera uma placa de veículo aleatória no formato antigo (3 letras, 4 números). * * @param mask - Se `true`, a placa será retornada com hífen (XXX-9999). * @returns A placa de veículo gerada. * @example * console.log(placaAntiga(true)); // "ABC-1234" * console.log(placaAntiga(false)); // "ABC1234" */ declare function placaAntiga(mask?: boolean): string; /** * Gera uma placa de veículo aleatória no formato Mercosul (3 letras, 1 número, 1 letra, 2 números). * * @param mask - Se `true`, a placa será retornada com hífen (XXX-9X99). * @returns A placa de veículo gerada. * @example * console.log(placaMercosul(true)); // "ABC-1D23" * console.log(placaMercosul(false)); // "ABC1D23" */ declare function placaMercosul(mask?: boolean): string; /** * Uma profissão aleatória. * @returns Uma profissão gerada aleatoriamente. * @example * console.log(profissao()); // Exemplo: "Advogado", "Engenheiro", etc. */ declare function profissao(): string; /** * Gera um provedor de e-mail aleatório. * @returns Um provedor de e-mail gerado aleatoriamente. * @example * console.log(provedorEmail()); // Exemplo: "@gmail.com", "@outlook.com", etc. */ declare function provedorEmail(): string; /** * Gera um número de RENAVAM aleatório. * * @returns O número de RENAVAM gerado. * @example * console.log(renavam()); // "12345678901" */ declare function renavam(): string; /** * Gera um número de RG aleatório. * @param mask - Se `true`, o RG será retornado com a máscara de formatação (xx.xxx.xxx-x). * @returns O RG gerado. * @example * console.log(rg(true)); // "12.345.678-9" * console.log(rg(false)); // "123456789" */ declare function rg(mask?: boolean): string; /** * Gera um número de telefone fixo aleatório. * * @param mask - Se true, o telefone será retornado com máscara (XX) XXXX-XXXX. * @param state - A sigla do estado para filtrar os DDDs. * @returns O número de telefone gerado. * @example * console.log(telefone()); // "1123456789" * console.log(telefone(true, "SP")); // "(11) 2345-6789" */ declare function telefone(mask?: boolean, state?: string): string; /** * Gera uma palavra aleatória. * @returns Uma palavra aleatória. */ declare function palavra(): string; /** * Gera uma sentença aleatória. * @param qttWords - Quantidade de palavras na sentença. * @returns Uma sentença aleatória. */ declare function sentenca(qttWords?: number): string; /** * Gera um parágrafo aleatório. * @param qttParagraph - Quantidade de parágrafos. * @param qttWords - Quantidade de palavras por sentença. * @returns Um parágrafo aleatório. */ declare function paragrafo(qttParagraph?: number, qttWords?: number): string; /** * Gera um tipo sanguíneo aleatório. * @returns Um tipo sanguíneo gerado aleatoriamente. * @example * console.log(tipoSanguineo()); // Exemplo: "A+", "O-", etc. */ declare function tipoSanguineo(): string; /** * Gera um número de Título de Eleitor aleatório. * * @param mask - Se `true`, o Título de Eleitor será retornado com a máscara (xxxx xxxx xxxx). * @param state - A sigla do estado para determinar a origem. * @returns O Título de Eleitor gerado. * @example * console.log(tituloEleitor()); * console.log(tituloEleitor(true, 'SP')); */ declare function tituloEleitor(mask?: boolean, state?: string): string; declare const gerar: { readonly apelido: typeof apelido; readonly banco: typeof banco; readonly cartaoCredito: typeof cartaoCredito; readonly celular: typeof celular; readonly cep: typeof cep; readonly certidao: { aleatoria(mask?: boolean): string; nascimento(mask?: boolean): string; casamento(mask?: boolean): string; obito(mask?: boolean): string; aleatoriaObj(mask?: boolean): CertidaoDetalhes; nascimentoObj(mask?: boolean): CertidaoDetalhes; casamentoObj(mask?: boolean): CertidaoDetalhes; obitoObj(mask?: boolean): CertidaoDetalhes; }; readonly cnh: typeof cnh; readonly cnhCategoria: typeof cnhCategoria; readonly cnpj: typeof cnpj; readonly cnpjAlfanumerico: typeof cnpjAlfanumerico; readonly cns: typeof cns; readonly codigoOperadora: typeof codigoOperadora; readonly contaBancaria: typeof contaBancaria; readonly corPele: typeof corPele; readonly cpf: typeof cpf; readonly dataNascimento: typeof dataNascimento; readonly ddd: typeof ddd; readonly email: typeof email; readonly endereco: typeof endereco; readonly escolaridade: typeof escolaridade; readonly genero: typeof genero; readonly identidadeGenero: typeof identidadeGenero; readonly identidadePorOrientacao: typeof identidadePorOrientacao; readonly inscricaoEstadual: typeof inscricaoEstadual; readonly listaCodigosBancos: typeof listaCodigosBancos; readonly nome: { aleatorio(): string; aleatorioCompleto(): string; masculino(): string; masculinoCompleto(): string; feminino(): string; femininoCompleto(): string; mae(): string; maeCompleto(): string; pai(): string; paiCompleto(): string; doMeio(): string; sobrenome(): string; }; readonly nomeEmpresa: typeof nomeEmpresa; readonly orientacaoSexual: typeof orientacaoSexual; readonly palavra: typeof palavra; readonly paragrafo: typeof paragrafo; readonly passaporte: typeof passaporte; readonly pis: typeof pis; readonly placaAntiga: typeof placaAntiga; readonly placaMercosul: typeof placaMercosul; readonly profissao: typeof profissao; readonly provedorEmail: typeof provedorEmail; readonly renavam: typeof renavam; readonly rg: typeof rg; readonly sentenca: typeof sentenca; readonly telefone: typeof telefone; readonly tipoSanguineo: typeof tipoSanguineo; readonly tituloEleitor: typeof tituloEleitor; }; export { apelido, banco, cartaoCredito, celular, cep, certidao, cnh, cnhCategoria, cnpj, cnpjAlfanumerico, cns, codigoOperadora, contaBancaria, corPele, cpf, dataNascimento, ddd, gerar as default, email, endereco, escolaridade, genero, gerar, identidadeGenero, identidadePorOrientacao, inscricaoEstadual, listaCodigosBancos, nome, nomeEmpresa, orientacaoSexual, palavra, paragrafo, passaporte, pis, placaAntiga, placaMercosul, profissao, provedorEmail, renavam, rg, sentenca, telefone, tipoSanguineo, tituloEleitor };