# boxen-notify

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

Latest version **1.0.0** (published 2016-10-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install boxen-notify
pnpm add boxen-notify
yarn add boxen-notify
bun add boxen-notify
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-10-21 |
| First published | 2016-10-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Ron Waldon |
| Maintainers | jokeyrhyme |

## Links

- npm: https://www.npmjs.com/package/boxen-notify
- Repository: https://github.com/jokeyrhyme/boxen-notify.js
- Homepage: https://github.com/jokeyrhyme/boxen-notify.js#readme
- Issues: https://github.com/jokeyrhyme/boxen-notify.js/issues
- npm.io page: https://npm.io/package/boxen-notify

## Dependencies (2)

- [boxen](https://npm.io/package/boxen.md) ^0.8.1
- [is-npm](https://npm.io/package/is-npm.md) 1.0.0

## Recent versions

- 1.0.0 (latest) — 2016-10-21

## 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)

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
```


## Resources

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

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

---
_Source: https://npm.io/package/boxen-notify · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._