ozdemirburak / full-name-generator

Generate random names using data from popular names and surnames of various countries.
https://fullnamegenerator.com
MIT License
26 stars 17 forks source link
hacktoberfest name random-name random-name-generator random-name-generators

Full Name Generator - Generate Random Names

npm-version npm-downloads

Generate random names effortlessly using various data sources of popular first names and surnames from multiple countries.

If you find this package helpful, please consider ⭐ starring it on GitHub.

Installation

$ npm install full-name-generator --save

Usage

import { firstName, lastName, fullName } from 'full-name-generator';

// Generate Full Names
const maleFullName = fullName('US', 0);
const femaleFullName = fullName('US', 1);

// Generate First Names
const maleFirstName = firstName('US', 0);
const femaleFirstName = firstName('US', 1);

// Generate Surnames
const turkishSurname = lastName('TR');
const czechFemaleSurname = lastName('CZ', 1);

// Generate Multiple Names
const twoAmericanMaleFirstNames = firstName('US', 0, 2);
const twoAmericanLastNames = lastName('US', null, 2);
const twoAmericanNamesThreeSurnamesFemaleFullName = fullName('US', 1, 2, 3);

Countries

Functions

fullName

Generates a full name based on the provided parameters.

fullName(isoCode: string, gender: Gender, firstN: number = 1, lastN: number = 1, space: string = ' '): string

firstName

Generates one or more first names based on the provided country code and gender.

firstName(isoCode: string, gender: Gender, n: number = 1): string

lastName

Generates one or more surnames. For some countries like the Czech Republic or Poland, gender is considered.

lastName(isoCode: string, gender?: Gender, n: number = 1): string

License

The MIT License (MIT). Please see License File for more information.

To reference this project, use the code snippet below:

<a href="https://fullnamegenerator.com">Full Name Generator</a>