HaikunatorJS
Generate Heroku-like random names to use in your node applications.
Installation
npm install --save haikunator
Usage
Haikunator is pretty simple.
var Haikunator = // ES6: import Haikunator from 'haikunator' // Instantiate Haikunator without options// var haikunator = new Haikunator() // Instantiate Haikunator with default optionsvar haikunator = adjectives: 'custom' 'adjectives' nouns: 'custom' 'nouns' seed: 'custom-seed' defaults: // class defaults tokenLength: 8 tokenChars: 'HAIKUNATOR' // ... // default usagehaikunator // => "wispy-dust-1337" // custom length (default=4)haikunator // => "patient-king-887265" // use hex instead of numbershaikunator // => "purple-breeze-98e1" // use custom chars instead of numbers/hexhaikunator // => "summer-atom-IHEA" // don't include a tokenhaikunator // => "cold-wildflower" // use a different delimiterhaikunator // => "restless.sea.7976" // no token, space delimiterhaikunator // => "delicate haze" // no token, empty delimiterhaikunator // => "billowingleaf"
Options
The following options are available:
var Haikunator = var haikunator = adjectives: 'custom' 'adjectives' nouns: 'custom' 'nouns' seed: 'custom-seed' // Custom seed defaults: // Class wide defaults, can get overridden by haikunate(options) delimiter: "-" tokenLength: 4 tokenHex: false tokenChars: "0123456789" // Same options are also available on the haikunate methodhaikunator
If tokenHex
is true, any tokens specified in tokenChars
are ignored
Contributing
Everyone is encouraged to help improve this project. Here are a few ways you can help:
- Report bugs
- Fix bugs and submit pull requests
- Write, clarify, or fix documentation
- Suggest or add new features
Other Languages
Haikunator is also available in other languages. Check them out:
- .NET: https://github.com/Atrox/haikunator.net
- Python: https://github.com/Atrox/haikunatorpy
- PHP: https://github.com/Atrox/haikunatorphp
- Java: https://github.com/Atrox/haikunatorjava
- Go: https://github.com/Atrox/haikunatorgo
- Perl: https://github.com/Atrox/haikunatorperl
- Dart: https://github.com/Atrox/haikunatordart
- Ruby: https://github.com/usmanbashir/haikunator
- Rust: https://github.com/nishanths/rust-haikunator