lance-cli-alerts

Cross platform CLI Alerts with colors & colored symbols for success, info, warning, error.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
lance-cli-alerts
1.0.24 months ago4 months agoMinified + gzip package size for lance-cli-alerts in KB

Readme

Install

npm install lance-cli-alerts

Usage

const alert = require('cli-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: Awais is awesome!}); // Prints: ℹ INFO Awais is 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)