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.
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)...
tryconst list = awaitcatch errconsole
...or the old way of doing it:
const names =namesnames
Both examples will result in a response that looks like the following:
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:
Here's the full list of all available options:
|amount||Amount of names to return, between
|gender||Limit results to the
|minLength||Require a minimum number of characters in a name||Integer|
|maxLength||Require a maximum number of characters in a name||Integer|
- Fork this repository to your own GitHub account and then clone it to your local device
- Link the package to the global module directory:
- Transpile the source code and watch for changes:
- 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!