This package acts as an API client for my favorite generator of random names: uinames. It's perfect for prototyping stuff or examples of real names in production apps.
Usage
Install the package using npm and save it to the dependency list:
npm install --save names
Now you have two choices to interact with the package. Since it's based on the concept of promises, you can either use async/await (it hasn't yet landed in node, so you'll have to transpile the code)...
import names from 'names'try { const list = await names()} catch (err) { console.error(err)}
Indipendent from which of the methods mentioned above you would like to use, you can always pass a configuration object to the module's main method:
names({ gender: 'female', amount: 10 ...})
Here's the full list of all available options:
Name
Description
Type
amount
Amount of names to return, between 1 and 500
Integer
gender
Limit results to the male or female gender
String
region
Region-specific results
String
minLength
Require a minimum number of characters in a name
Integer
maxLength
Require a maximum number of characters in a name
Integer
Contribute
Fork this repository to your own GitHub account and then clone it to your local device
Link the package to the global module directory: npm link
Transpile the source code and watch for changes: npm start
Within the module you want to test your local development instance of names, just link it to the dependencies: npm link names. Instead of the default one from npm, node will now use your clone of names!