https://github.com/bukinoshita/shout-success

An opinionated success message
https://github.com/bukinoshita/shout-success

console javascript message nodejs success

Last synced: 5 months ago
JSON representation

An opinionated success message

• Host: GitHub
• URL: https://github.com/bukinoshita/shout-success
• Owner: bukinoshita
• License: mit
• Created: 2017-06-17T23:41:56.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2023-01-05T08:06:06.000Z (almost 3 years ago)
• Last Synced: 2025-06-09T19:16:48.046Z (5 months ago)
• Topics: console, javascript, message, nodejs, success
• Language: TypeScript
• Size: 606 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

          
# shout-success [![Build Status](https://travis-ci.org/bukinoshita/shout-success.svg?branch=master)](https://travis-ci.org/bukinoshita/shout-success)

> An opinionated success message



## Install

```

$ yarn add shout-success

```

## Usage

```js

const { shoutSuccess } = require('shout-success')

shoutSuccess('Profile saved.')

```

_Uses [chalk](https://github.com/chalk/chalk), will return a success message with a nice color._

## API

### shoutSuccess(message, label)

#### message

Type: `string`


Required

#### label

Type: `string`


Default: `> Success!`

## Related

- [shout-message](https://github.com/bukinoshita/shout-message) — An opinionated message

- [shout-error](https://github.com/bukinoshita/shout-error) — An opinionated error message

## License

MIT © [Bu Kinoshita](https://bukinoshita.com)