https://github.com/jokeyrhyme/boxen-notify.js

show a message in a box (extracted from update-notifier)
https://github.com/jokeyrhyme/boxen-notify.js

Last synced: 11 days ago
JSON representation

show a message in a box (extracted from update-notifier)

• Host: GitHub
• URL: https://github.com/jokeyrhyme/boxen-notify.js
• Owner: jokeyrhyme
• License: mit
• Created: 2016-10-21T02:16:09.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-03-02T19:34:12.000Z (over 1 year ago)
• Last Synced: 2024-04-14T13:07:34.266Z (7 months ago)
• Language: JavaScript
• Size: 1.03 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# boxen-notify [![npm](https://img.shields.io/npm/v/boxen-notify.svg?maxAge=2592000)](https://www.npmjs.com/package/boxen-notify) [![AppVeyor Status](https://ci.appveyor.com/api/projects/status/d6tm9xe9jt8839am?svg=true)](https://ci.appveyor.com/project/jokeyrhyme/boxen-notify-js) [![Travis CI Status](https://travis-ci.org/jokeyrhyme/boxen-notify.js.svg?branch=master)](https://travis-ci.org/jokeyrhyme/boxen-notify.js) [![AppVeyor Status](https://img.shields.io/appveyor/ci/jokeyrhyme/boxen-notify-js/master.svg)](https://ci.appveyor.com/project/jokeyrhyme/boxen-notify-js)

show a message in a box (extracted from update-notifier)

## Usage

### `notify(options: BoxenNotifyOptions)`

```flowtype

type BoxenNotifyOptions = {

  boxenOpts?: BoxenOptions,

  defer?: boolean,

  message?: string

}

```

- see upstream documentation for [BoxenOptions](see: https://github.com/sindresorhus/boxen#boxeninput-options)

- output **message** now, or **defer** until the process exits

- same behaviour as upstream: does nothing if not in an interactive terminal, or if run as part of an `npm run` script

### Example

```js

const { notify } = require('boxen-notify');

notify({ message: 'hello, world!' });

```

## Contributing

### Development

```sh

npm install --global flow-typed

npm install

flow-typed install

npm test

```

## See Also

- [boxen](https://github.com/sindresorhus/boxen)

- [update-notifier](https://github.com/yeoman/update-notifier)