1.0.2 • Published 4 years ago
commanding-alerts v1.0.2
commanding-alerts
Install
npm install commanding-alerts
Usage
const alert = require('commanding-alerts');
// Provide the type, msg, and name options.
alert({ type: `success`, msg: `Everything finished!` });
// Prints: ✔ SUCCESS Everything finished!
alert({ type: `success`, msg: `Everything finished!`, name: `DONE` });
// Prints: ✔ DONE Everything finished!
alert({ type: `warning`, msg: `You didn't add something!` });
// Prints: ⚠ WARNING You didn't add something!
alert({ type: `info`, msg: `You are awesome!` });
// Prints: ℹ INFO You are awesome!
alert({ type: `error`, msg: `Something went wrong!` });
// Prints: ✖ ERROR Something went wrong!
API
alert(options)
❯ options
Type: object
Default: {}
You can specify the options below.
❯ type
Type: string
Default: error
❯ msg
Type: string
Default: You forgot to define all options.
(Error message)
❯ name
Type: string
Default: ''
(Empty string)
Changelog
KEY: 📦 NEW
, 👌 IMPROVE
, 🐛 FIX
, 📖 DOC
, 🚀 RELEASE
, and 🤖 TEST
I use Emoji-log, you should try it and simplify your git commits.