From 161d5cc002c2f03134b31962fd5c6d81add4f567 Mon Sep 17 00:00:00 2001 From: Prosen-Ghosh Date: Sat, 26 Aug 2017 16:37:48 +0600 Subject: [PATCH] README File Updated and package version updated --- README.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++++ index.js | 2 +- package.json | 2 +- src/pro-users.js | 3 ++- 4 files changed, 55 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 37ae4da..fd3f7e2 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,58 @@ console.log(rand.generateNumber(0)); console.log(rand.generateNumber(300)); // 94 ``` +# Users +***generateName()*** This function Will generate random name. +```javascript +var rand = require('random-pro'); +console.log(rand.generateName()); +// Johirul +console.log(rand.generateName()); +// Abhijit +``` +You can also use gender for generate name. +***generateName(gender)*** This Function will generate name based on gender. Gender Is case insensitive. +```javascript +var rand = require('random-pro'); +console.log(rand.generateName("male")); +// Sany +console.log(rand.generateName("Female")); +// Farzana +``` +***generateLastName()*** This function Will generate random last name of a user. + +```javascript +var rand = require('random-pro'); +console.log(rand.generateLastName()); +// Rahman +console.log(rand.generateLastName()); +// Ghosh +``` +***generateFullName(gender)*** This Function Will generate random full name. The Deafult parameter of the function is `Male`. + +```javascript +var rand = require('random-pro'); +console.log(rand.generateFullName()); +// Ovi Ahmed +console.log(rand.generateFullName()); +// Shovon Mollah +console.log(rand.generateFullName('female')); +// Masuma Gazi +console.log(rand.generateFullName("Female")); +// Rukaiya Shawkat + +``` + +***generateEmail()*** This function will generate random email address for user. + +```javascript +var rand = require('random-pro'); +console.log(rand.generateEmail()); +// rajubhowmik@tbwt.com +console.log(rand.generateEmail()); +// ezazkundu@yyhmail.com +``` # License MIT \ No newline at end of file diff --git a/index.js b/index.js index f048068..fceea31 100644 --- a/index.js +++ b/index.js @@ -1,6 +1,6 @@ var numberPro = require('./src/pro-number.js'); var usersPro = require('./src/pro-users'); - +console.log(usersPro.randGenerateEmail()) module.exports = { generateNumber : numberPro.randNumber, generateName : usersPro.randGenerateUserName, diff --git a/package.json b/package.json index 6a4d660..3c7b42e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "random-pro", - "version": "0.0.4", + "version": "0.0.5", "description": "A JavaScript package for random things.", "main": "index.js", "scripts": { diff --git a/src/pro-users.js b/src/pro-users.js index 0e5e57b..44135db 100644 --- a/src/pro-users.js +++ b/src/pro-users.js @@ -21,8 +21,9 @@ var randGenerateEmail = function(){ // } var randGenerateFullName = function(gender){ + gender = gender || "MALE"; var locNames = gender.toUpperCase() == "MALE" ? names.firstNameMale : names.firstNameFemale; - return locNames[Math.floor(Math.random()*locNames.length)] + names.lastName[Math.floor(Math.random()*names.lastName.length)]; + return locNames[Math.floor(Math.random()*locNames.length)] + " " + names.lastName[Math.floor(Math.random()*names.lastName.length)]; } module.exports = { randGenerateUserName,