Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 1.32 KB

README.md

File metadata and controls

59 lines (39 loc) · 1.32 KB
Raw

Chinese Random Name

Generate Chinese name using Node.js with ❤️.

Installation

$ npm install chinese-random-name

Usage

Generate a Full Name Automatically

Using generate function:

var randomName = require("chinese-random-name");

console.log(randomName.generate());

Only Surname

Using getOne function in surnames.

console.log(randomName.surnames.getOne());

Name

Using get / get1 / get2 / get3 function in names.

  • get: returns a random name and its length between 1 and 3.
  • get1: returns a random name with length 1. (you can pass a parameter which may be "金" / "木" / "水" / "火" / "土" or leave it blank)
  • get2: returns a random name with length 2. (you can pass "金金" / "金木" / ... or leave it blank)
  • get3: returns a random name with length 3. (you can pass "金金金" / "水火土" / ... or leave it blank)
  • dict: the dictionary object.

Examples:

randomName.names.get();
randomName.names.get1();
randomName.names.get2();
randomName.names.get3();
randomName.names.get1("金");
randomName.names.get2("木水");
randomName.names.get3("火火火");

Related Article

http://xcoder.in/2014/09/01/how-i-made-chinese-random-x/

Contribute

You're welcome to fork and make pull requests!