1.1.0 • Published 3 years ago

@guineatech/cli-alerts v1.1.0

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

📟

Install

npm install @guineatech/cli-alerts
yarn add  @guineatech/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`, data: {name: 'alpha'}});
// Prints: ✔ DONE Everything finished! {
//   name: 'alpha'
//}

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)

📃

License & Conduct