# bit-message-box

> Boxed console messages for NodeJS terminal

Latest version **1.1.0** (published 2021-05-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install bit-message-box
pnpm add bit-message-box
yarn add bit-message-box
bun add bit-message-box
```

## 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.1.0 |
| Published | 2021-05-02 |
| First published | 2019-08-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 17.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Vladimir Jovanović |
| Maintainers | vlasterx |
| Keywords | console, message, terminal |

## Links

- npm: https://www.npmjs.com/package/bit-message-box
- Repository: https://github.com/Bitersen/bit-message-box
- Homepage: https://github.com/Bitersen/bit-message-box#readme
- Issues: https://github.com/Bitersen/bit-message-box/issues
- npm.io page: https://npm.io/package/bit-message-box

## Dependencies (2)

- [boxen](https://npm.io/package/boxen.md) ^5.0.1
- [chalk](https://npm.io/package/chalk.md) ^4.1.1

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2021-05-02
- 1.0.1 — 2019-08-31
- 1.0.0 — 2019-08-27

## README

# bit-message-box

Just a simple plugin that adds border around your console messages in NodeJS terminal.

For more customization options, consider using [boxen](https://www.npmjs.com/package/boxen) and [chalk](https://www.npmjs.com/package/chalk) plugins.

## Installation

Install the plugin:

```
npm install --save-dev bit-message-box
```

Add it to your script:

```js
const msg = require('bit-message-box')
```

## Methods

| Name     | Result                                       |
| -------- | -------------------------------------------- |
| `log`    | Returns white text with green border         |
| `info`   | Returns blue text with blue border           |
| `warn`   | Returns yellow text with yellow border       |
| `error`  | Returns red text with red border             |
| `assert` | Displays message if the condition is `false` |

## Example

```js
msg.info('This is just an info message')
```

```js
let myCondition = 1 > 2

msg.assert(myCondition, 'Message is displayed if the condition is false')
```

![Info message](./static/msg-examples.png)


## Author

Vladimir Jovanović | [Personal website](https://webdizajn.org) | [LinkedIn](https://www.linkedin.com/in/-v-j-/)

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