better-cli-alerts
v1.1.4
Published
CLI alerts with colors and symbols: success, info, warning, error. Cross platform comaptible: Windows, MacOS,
Downloads
13
Readme
Cross platform CLI Alerts with colors with Catpuccin colors and custom messages. Work on macOS, Linux, and Windows.
better-cli-alerts
Install
npm install better-cli-alerts
Usage
const alert = require("better-cli-alerts");
// or if you use modules
import alert from "better-cli-alerts";
// Success message
alert({
type: `success`,
message: ` All is good! `,
description: `SUCCESS`
});
// Info message
alert({
type: `info`,
message: ` Some useful info `,
description: `INFO`
});
// Warning message
alert({
type: `warning`,
message: ` Careful! `,
description: `WARNING`
});
// Error message
alert({
type: `error`,
message: ` Something is wrong! `,
description: `ERROR`
});
// Using custom messages
alert({
type: `error`,
message: ` Something is wrong! `,
description: `YOUR CUSTOM MESSAGE`
});
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)
❯ description
Type: string
Default: ''
(Empty string)