JSPM

nicknames

1.0.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 56
  • Score
    100M100P100Q85881F
  • License MIT

Generate nicknames

Package Exports

  • nicknames

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (nicknames) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Nicknames

Generate male and female nicknames. Based off Sindre Sorhus' Dog Names.

Install

$ npm install --save nicknames

Usage

var nicknames = require('nicknames');

nicknames.femaleRandom();
//=> Cookie

API

.female

Type: array

Top 100 female nicknames sorted by popularity.

.male

Type: array

Top 100 male nicknames sorted by popularity.

.all

Type: array

Top 200 nicknames sorted by popularity.

.femaleRandom()

Type: function

Random female nickname.

.maleRandom()

Type: function

Random male nickname.

.allRandom()

Type: function

Random nickname.

CLI

$ npm install --global nicknames
$ nicknames --help

  Examples
    $ nicknames
    Cookie

    $ nicknames --all --type male
    Champ
    Captain
    ...

  Options
    --all   Get all names instead of a random name
    --type  Type of name: female|male|all  Default: all

Release History

  • 1.0.2: Add new nicknames.
  • 1.0.1: Update documentation.
  • 1.0.0: Initial release.

Contributing

  1. Fork it
  2. Run npm install
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Commit your changes (git commit -am "Add some feature")
  5. Push to the branch (git push origin my-new-feature)
  6. Create new Pull Request

License

MIT © Ryan Burgess