jokeyrhyme / boxen-notify.js

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

boxen-notify

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

Usage

notify(options: BoxenNotifyOptions)

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

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

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

Contributing

Development

npm install --global flow-typed
npm install
flow-typed install
npm test

See Also

• boxen

• update-notifier