@graysitory/notify
v1.0.5
Published
A simple utility to emit console messages with emojis and color-coded levels for success, warnings, errors, info, and standard messages.
Downloads
5
Readme
@graysitory/notify
A simple utility to emit console messages with emojis and color-coded levels for success, warnings, errors, and more. It uses Node.js's EventEmitter
and the colors
package to display messages in a visually distinct format, with defaults for each message type.
Features:
- Emit success (
✅
), warning (⚠️
), error (🚨
), info (ℹ️
), or generic messages with custom icons and text. - Messages are color-coded using
colors
:- Success messages are green.
- Warnings are yellow.
- Errors are red.
- Info messages are blue.
- Generic messages have no color by default.
- Customize the icon by passing a different emoji or symbol.
Usage:
Install the package:
npm install @graysitory/notify
Import and use it in your project:
import { success, warn, error, info, message } from '@graysitory/notify'; success({ msg: 'Operation successful!' }); // ✅ Operation successful! (green) warn({ msg: 'This is a warning!' }); // ⚠️ This is a warning! (yellow) error({ msg: 'Something went wrong!' }); // 🚨 Something went wrong! (red) info({ msg: 'Informational message.' }); // ℹ️ Informational message. (blue) message({ icon: '🔔', msg: 'Custom icon message' }); // 🔔 Custom icon message (default color) success(`This is a string`) // pass a string to use default icon and message color
Customizing Messages:
- Pass a custom
icon
in theMessage
object to change the emoji displayed with the message. - If no
icon
is provided, a default emoji is used for each message type.
- Pass a custom
Message Types:
- success(args): Emits a success message with a default checkmark
✅
. - warn(args): Emits a warning message with a default warning symbol
⚠️
. - error(args): Emits an error message with a default emergency symbol
🚨
. - info(args): Emits an informational message with a default info symbol
ℹ️
. - message(args): Emits a generic message with a default icon
⌙
.