randomchinesename v0.0.4

Instructions for use about randomchinesename

1. Install

$ npm install randomchinesename

2. Usage

The principle of naming : Hundred surnames

const randomChineseName = require('randomchinesename');

const arr = randomChineseName.getName();

console.log(arr);

Parameter Description

const randomChineseName = require("randomchinesename");

const log = console.log;

/**
 * Default parameter setting
 * --------------------------
 * randomChineseName.getName() = randomChineseName.getName("male",1000);
 * --------------------------------------------------------------------
 * note :  The parameter can not be three or more than three, 
 * otherwise execute the function according to the default parameters!
 * --------------------------------------------------------------------
 * prompt : The order of the parameters is not specified!
 * ------------------------------------------------------
 * @param {string} gender : ["male", "female"]
 * -------------------------------------------
 * @param {number} quantity
 * ------------------------
 * @return List
 */

log(randomChineseName.getName());
=> ['刘半仙','欧阳瀚玥','亓官同光','申屠孝先','景明辉'... 995 more items];

/**
 * Only one gender parameter ： default quantity 1000
 */
log(randomChineseName.getName("female"));
=> ['满若芳','那晓灵','叶冰心','燕寻春','况后芳菲'... 995 more items];

/**
 * Only one quantity parameter ： default gender "male"
 */
log(randomChineseName.getName(6));
=> [ '魏乐和', '钱正真', '程正奇', '封飞章', '终乐康', '葛玉韵'];

/**
 * The order of the parameters can be reversed
 */
log(randomChineseName.getName("female", 10));
log(randomChineseName.getName(10, "female"));

Stay tuned for more naming features