Giter Club home page Giter Club logo

rand-name-gen's Introduction

Random Name GEnerator

NPM Version license: MIT Downloads

Logo

Description

rand-name-gen is a simple and lightweight npm package for generating random names.

Installation

Install the package with npm:

npm install rand-name-gen

Usage

const rand = require("rand-name-gen");

console.log(rand.randomName()); // Output: { 'John Doe' }
console.log(rand.randomName({ title: true })); // Output: { 'Mr. John Doe' }
console.log(rand.randomName({ firstName: true })); // Output: { 'John' }
console.log(rand.randomName({ lastName: true })); // Output: { 'Doe' }

OR

import { randomName } from "rand-name-gen";

console.log(randomName({ firstName: true, lastName: true })); // Output: { 'John Doe' }
console.log(randomName({ title: true, firstName: true })); // Output: { 'Mr. John' }
console.log(randomName({ title: true, firstName: true, lastName: true })); // Output: { 'Mr. John Doe' }

API

  • randomName() - Returns a random full name without title.
  • randomName({ title: true }) - Returns a random full name with a title.
  • randomName({ firstName: true }) - Returns a random first name.
  • randomName({ lastName: true }) - Returns a random last name.
  • randomName({ title: true, firstName: true }) - Returns a random first name with a title.
  • randomName({ title: true, lastName: true }) - Returns a random last name with a title.
  • randomName({ firstName: true, lastName: true }) - Returns a random first and last name.
  • randomName({ title: true, firstName: true, lastName: true }) - Returns a random first and last name with a title.

Options

  • title - (Optional) - Boolean value to include a title.
  • firstName - (Optional) - Boolean value to include a first name.
  • lastName - (Optional) - Boolean value to include a last name.

License

This project is licensed under the MIT License.

Author

Preyan Bhowmick

rand-name-gen's People

Contributors

github-actions[bot] avatar preyan avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.