awesome-greetings
v1.0.0
Published
awesome-greetings
Maintainers
Readme
awesome-greetings
A small ESM npm package that returns random greetings from different styles.
Installation
npm install awesome-greetingsUsage
This package is ESM ("type": "module"), so use import:
import { getAwesomeGreeting } from 'awesome-greetings';
console.log(getAwesomeGreeting());
// Example output: "Hi there, I hope all is well."
console.log(getAwesomeGreeting({ type: 'energetic', name: 'Alice' }));
// Example output: "Yo yo Alice! What's the vibe today?"API
getAwesomeGreeting(options?)
Returns one random greeting string.
Options:
type(string, default:"polite"): greeting style.name(string, default:""): name to inject into{awesome-name}placeholders.
Supported greeting types:
politeenergeticcrazy
Behavior notes:
- If
typeis invalid, it falls back topolite.
Examples
import { getAwesomeGreeting } from 'awesome-greetings';
getAwesomeGreeting({ type: 'polite', name: 'Bob' });
// "Good afternoon Bob, I hope everything is going smoothly."
getAwesomeGreeting({ type: 'crazy' });
// "Yo yo!! Is it me or did the room just get cooler?"License
MIT
