https://github.com/danielperez9430/esbuild-os-notifier
Esbuild plugin for receive OS notification when your build finish
https://github.com/danielperez9430/esbuild-os-notifier
esbuild esbuild-plugin hacktoberfest nodejs notifications
Last synced: about 1 year ago
JSON representation
Esbuild plugin for receive OS notification when your build finish
- Host: GitHub
- URL: https://github.com/danielperez9430/esbuild-os-notifier
- Owner: danielperez9430
- License: mit
- Created: 2022-09-24T17:37:07.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-19T13:41:39.000Z (almost 2 years ago)
- Last Synced: 2025-03-21T05:04:20.805Z (about 1 year ago)
- Topics: esbuild, esbuild-plugin, hacktoberfest, nodejs, notifications
- Language: TypeScript
- Homepage:
- Size: 23.4 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# esbuild-os-notifier
[](https://www.npmjs.com/package/esbuild-os-notifier)
[](https://www.npmjs.com/package/esbuild-os-notifier)
Esbuild plugin for receive OS notification when your build finish, have an error or a warning
## 📦 Install
> yarn add dev esbuild-os-notifier
or
> npm i -D esbuild-os-notifier
## 🚀 Usage
Add it to your esbuild plugins list:
```js
// ESM example with import
import { build } from 'esbuild'
import esbuildOsNotifier from 'esbuild-os-notifier'
build({
...
plugins: [
esbuildOsNotifier()
]
...
});
```
```js
// CommonJs example with require
const esbuild = require("esbuild");
const esbuildOsNotifier = require('esbuild-os-notifier')
esbuild.build({
...
plugins: [
esbuildOsNotifier()
]
...
});
```
## Options
You can add your own custom configuration of options to esbuildOsNotifier
```js
esbuildOsNotifier({
// Options from "node_notifier"
contentImage: '' // Path to png image (Recomend 300x300px) for display in the notification
sound: true, // Only Notification Center or Windows Toasters (true/false)
timeout: 5000, // Time (in milliseconds) to clear the notifications
},
{
// Show or disable notifications for error, warnings or sucess
warnings: false,
errors: true,
success: true
});
```