# bnotify
> A notification system written in NodeJS using the BAT platform.
Latest version **1.3.15** (published 2025-02-13) · MIT license · 0 weekly downloads
## Install
```sh
npm install bnotify
pnpm add bnotify
yarn add bnotify
bun add bnotify
```
Provides the command `bnotify`.
## Health
**Score 25/100 (F)** — status: maintenance-mode.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: stale; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.3.15 |
| Published | 2025-02-13 |
| First published | 2015-01-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 9.9 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Ionică Bizău |
| Maintainers | ionicabizau |
| Keywords | bat, notify |
## Links
- npm: https://www.npmjs.com/package/bnotify
- Repository: https://github.com/IonicaBizau/bnotify
- Issues: https://github.com/IonicaBizau/bnotify/issues
- npm.io page: https://npm.io/package/bnotify
## Dependencies (6)
- [ul](https://npm.io/package/ul.md) ^1.1.0
- [ws](https://npm.io/package/ws.md) 7.3.1
- [lien](https://npm.io/package/lien.md) 0.0.7
- [batjs](https://npm.io/package/batjs.md) 1.0.0
- [jsonrequest](https://npm.io/package/jsonrequest.md) ^1.1.0
- [forever-monitor](https://npm.io/package/forever-monitor.md) ^1.5.2
## Recent versions
- 1.3.15 (latest) — 2025-02-13
- 1.3.14 — 2020-08-09
- 1.3.13 — 2019-01-03
- 1.3.12 — 2017-12-24
- 1.3.11 — 2017-12-24
- 1.3.10 — 2017-09-08
- 1.3.9 — 2017-09-07
- 1.3.8 — 2017-03-23
- 1.3.7 — 2017-03-20
- 1.3.6 — 2016-10-11
- 1.3.5 — 2016-10-10
- 1.3.4 — 2016-05-25
- 1.3.3 — 2016-04-25
- 1.3.2 — 2016-04-25
- 1.3.1 — 2016-01-14
- … 4 more at https://npm.io/package/bnotify/versions
## README
[](#)
# `$ bnotify`
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [](https://github.com/IonicaBizau/ama) [](https://www.npmjs.com/package/bnotify) [](https://www.npmjs.com/package/bnotify) [](https://www.codementor.io/@johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
> A notification system written in NodeJS using the BAT platform.
## :cloud: Installation
You can install the package globally and use it as command line tool:
```sh
# Using npm
npm install --global bnotify
# Using yarn
yarn global add bnotify
```
Then, run `bnotify --help` and see what the CLI tool can do.
```
$ bnotify --help
Usage: bnotify <description> <duration> <icon>
```
Ensure you have [installed](https://github.com/IonicaBizau/dotfiles#applications) and [configured NodeJS and NPM](https://github.com/IonicaBizau/dotfiles#npm-config).
Ensure you have installed the [BAT](https://github.com/IonicaBizau/bat#installation) on your machine.
## Screenshots
```sh
$ bnotify 'Hello World' 'I am BNotify' 10000
```
### Multiple notifications
### Multiple notifications
## :clipboard: Example
Here is an example how to use this package as library. To install it locally, as library, you can use `npm install bnotify` (or `yarn add bnotify`):
```js
// Dependencies
var BNotify = require("bnotify");
// Show the notification
BNotify({
title: "Test Notification"
, description: "Adipisicing molestias soluta consectetur debitis doloribus. Doloremque amet temporibus suscipit quis ipsum vitae rerum ad iure nulla repellat iure molestias. Provident reiciendis veritatis doloribus maxime eum repellendus aut possimus ab!"
, duration: 4000
, icon: "/bell.png"
}, function () {
process.exit(0);
});
```
## :question: Get Help
There are few ways to get help:
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
## :memo: Documentation
For full API reference, see the [DOCUMENTATION.md][docs] file.
## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].
## :sparkling_heart: Support my projects
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
- Starring and sharing the projects you like :rocket:
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
- [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
- **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`
Thanks! :heart:
## :scroll: License
[MIT][license] © [Ionică Bizău][website]
[license]: /LICENSE
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
[patreon]: https://www.patreon.com/ionicabizau
[amazon]: http://amzn.eu/hRo9sIZ
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
---
_Source: https://npm.io/package/bnotify · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._