boxen-notify

1.0.0 • Public • Published

boxen-notify npm AppVeyor Status Travis CI Status

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

  • 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

Resources

Readme

Keywords

none

Package Sidebar

Install

npm i boxen-notify

Weekly Downloads

190

Version

1.0.0

License

MIT

Last publish

Collaborators

  • jokeyrhyme