1.2.0 • Published 3 months ago
yet-another-name-generator v1.2.0
YANG
Yet Another Name Generator
Install
$ pnpm add yet-another-name-generator
# or
$ npm add yet-another-name-generator
# or
$ yarn add yet-another-name-generatorTest
$ pnpm run testUsage
import { generate } from 'yet-another-name-generator'
generate()Some examples:
- nostalgic clod-hopper
- spiritual bagman
- lacking codman
- pumped boatwright
- melted minnow
- mere kite
- silky opah
- blue butcher
- drunk canadian mountie
- mountainous herpetologist
API
generate(options);Options
| Option | Type | Description |
|---|---|---|
| the | boolean | If true, adds the word "the" to the beginning of the string. |
| titleize | boolean | If true, capitalizes the first letter of each word in the string. |
| separator | boolean | string | - If false, trims spaces between the words, making it one long string. |
| - If a string, replaces the whitespace between words with your custom separator. |
Examples
generate({the: true})
// -> the bloody jagger
generate({the: true, titleize: true})
// -> The Magical Minnow
generate({titleize: true, separator: false})
// -> SoggyPoacher
generate({the: true, titleize: true, separator: '-'})
// -> The-Spiritual-Princess