joyful
v1.0.0
Published
A list of friendly words to use in your app.
Maintainers
haydenbleaselReadme
joyful
Generate delightful, random word combinations for your app — perfect for project names, usernames, or unique identifiers.
Installation
pnpm add joyfulUsage
import { joyful } from "joyful";
joyful(); // "amber-fox"
joyful(3); // "golden-marble-cathedral"
joyful(3, "_"); // "swift_northern_lights"API
joyful(segments?, separator?)
| Parameter | Type | Default | Description |
| ----------- | -------- | ------- | ------------------------------ |
| segments | number | 2 | Number of words to generate |
| separator | string | "-" | Character(s) between words |
Returns a string of random words joined by the separator.
Word Categories
The first word is always a prefix (adjective or color). Subsequent words are drawn from:
animals, architecture, art, emotions, fashion, food, history, literature, music, mythology, nature, professions, science, space, sports, transportation
Permutations
| Segments | Combinations | | -------- | ------------------------ | | 2 | 700,295 | | 3 | 2,160,410,075 | | 4 | 6,664,865,081,375 | | 5 | 20,561,108,776,041,876 |
Credits
Based on friendly-words by Glitch, with curated word lists and additional categories.
License
ISC