gerador-br/dist/cjs/generators/nome.cjs

Gerador de Dados Fictícios - Brasil

'use strict';

var utils = require('../utils.cjs');

/**
 * Gera nomes aleatórios.
 *
 * Este objeto fornece métodos para gerar nomes masculinos, femininos, completos, de mães e pais,
 * nomes do meio e sobrenomes.
 *
 * @example
 * // Gerar um nome aleatório
 * console.log(nome.aleatorio()); // Ex: "João", "Maria"
 *
 *  // Gerar um nome aleatório completo
 * console.log(nome.aleatorioCompleto()); // Ex: "João Santos da Silva", "Maria Santos da Silva"
 *
 * // Gerar um nome masculino aleatório
 * console.log(nome.masculino()); // Ex: "João"
 *
 * // Gerar um nome masculino completo aleatório
 * console.log(nome.masculinoCompleto()); // Ex: "João Santos da Silva"
 *
 * // Gerar um nome feminino aleatório
 * console.log(nome.feminino()); // Ex: "Maria"
 *
 * // Gerar um nome feminino completo aleatório
 * console.log(nome.femininoCompleto()); // Ex: "Maria Santos da Silva"
 *
 * // Gerar o nome da mãe aleatório
 * console.log(nome.mae()); // Ex: "Ana"
 *
 * // Gerar o nome completo da mãe aleatório
 * console.log(nome.maeCompleto()); // Ex: "Ana Santos da Silva"
 *
 * // Gerar o nome do pai aleatório
 * console.log(nome.pai()); // Ex: "José"
 *
 * // Gerar o nome completo do pai aleatório
 * console.log(nome.paiCompleto()); // Ex: "José Santos da Silva"
 *
 * // Gerar um nome do meio aleatório
 * console.log(nome.doMeio()); // Ex: "Santos"
 *
 * // Gerar um sobrenome aleatório
 * console.log(nome.sobrenome()); // Ex: "da Silva"
 */
const nome = {

  /**
  * Gera um nome aleatório.
  * @returns {string} Um nome aleatório.
  */
  aleatorio() { return utils.nomeAleatorioRand; },

  /**
  * Gera um nome aleatório completo.
  * @returns {string} Um nome aleatório completo.
  */
  aleatorioCompleto() { return `${utils.nomeAleatorioRand} ${utils.nomeDoMeioRand} ${utils.sobrenomeRand}`; },

  /**
   * Gera um nome masculino aleatório.
   * @returns {string} Um nome masculino aleatório.
   */
  masculino() { return utils.nomeMasculinoRand; },

  /**
   * Gera um nome masculino completo aleatório.
   * @returns {string} Um nome masculino completo aleatório.
   */
  masculinoCompleto() { return `${utils.nomeMasculinoRand} ${utils.nomeDoMeioRand} ${utils.sobrenomeRand}`; },

  /**
   * Gera um nome feminino aleatório.
   * @returns {string} Um nome feminino aleatório.
   */
  feminino() { return utils.nomeFemininoRand; },

  /**
   * Gera um nome feminino completo aleatório.
   * @returns {string} Um nome feminino completo aleatório.
   */
  femininoCompleto() { return `${utils.nomeFemininoRand} ${utils.nomeDoMeioRand} ${utils.sobrenomeRand}`; },

  /**
   * Gera o nome da mãe aleatório.
   * @returns {string} O nome da mãe aleatório.
   */
  mae() { return `${utils.nomeMaeRand}`; },

  /**
   * Gera o nome completo da mãe aleatório.
   * @returns {string} O nome completo da mãe aleatório.
   */
  maeCompleto() { return `${utils.nomeMaeRand} ${utils.nomeDoMeioRand} ${utils.sobrenomeRand}`; },

  /**
   * Gera o nome do pai aleatório.
   * @returns {string} O nome do pai aleatório.
   */
  pai() { return `${utils.nomePaiRand}`; },

  /**
   * Gera o nome completo do pai aleatório.
   * @returns {string} O nome completo do pai aleatório.
   */
  paiCompleto() { return `${utils.nomePaiRand} ${utils.nomeDoMeioRand} ${utils.sobrenomeRand}`; },

  /**
   * Gera um nome do meio aleatório.
   * @returns {string} Um nome do meio aleatório.
   */
  doMeio() { return utils.nomeDoMeioRand; },

  /**
   * Gera um sobrenome aleatório.
   * @returns {string} Um sobrenome aleatório.
   */
  sobrenome() { return utils.sobrenomeRand; },
};

exports.nome = nome;