node-notifier
Advanced tools
Package description
The node-notifier package is a Node.js module for sending native notifications on different platforms like Windows, Mac, and Linux. It provides an easy-to-use API to show system notifications using the native notification system of the operating system.
Cross-platform notifications
This feature allows you to send desktop notifications across different operating systems. The code sample shows how to send a simple notification with a title and a message.
const notifier = require('node-notifier');
notifier.notify({
title: 'My notification',
message: 'Hello, this is a notification!'
});Notification actions
This feature allows you to listen for user interactions with the notification, such as clicking on it. The code sample demonstrates how to handle a click event on the notification.
const notifier = require('node-notifier');
notifier.notify({
title: 'My notification',
message: 'Click to perform an action',
wait: true
}, (err, response, metadata) => {
if (metadata.activationType === 'clicked') {
console.log('Notification clicked!');
}
});Custom notification sound
This feature allows you to customize the notification sound and appearance. The code sample shows how to send a notification with a custom sound and icon.
const notifier = require('node-notifier');
notifier.notify({
title: 'My notification',
message: 'With a custom sound!',
sound: true, // Only Notification Center or Windows Toasters
appIcon: '/path/to/icon.png', // Absolute path (doesn't work on balloons)
contentImage: '/path/to/image.png' // Absolute Path to Attached Image (Content Image)
});A package specifically designed for Electron applications to show desktop notifications. It is similar to node-notifier but tailored for the Electron environment, which means it might not be suitable for non-Electron Node.js applications.
This package allows you to send notifications using the Pushover service. It differs from node-notifier in that it requires an internet connection and uses the Pushover API to send messages to devices, whereas node-notifier works offline and uses the native OS notification systems.
Toastr is a Javascript library for non-blocking notifications. It is designed for web applications and provides in-browser notifications as opposed to the system-level notifications provided by node-notifier.
Readme
A Node.js wrapper for the terminal-notifier application by Eloy Durán.
If using Linux, notify-send must be installed on your system.
However, terminal-notifier, comes
bundled in the module. So on Mac, not additional installations is necessary.
$ npm install node-notifier
Same usage and parameter setup as terminal-notifier.
Where terminal-notifier say to use the -message option, you can do this in node-notifier
var notifier = require('node-notifier');
notifier.notify({
message: 'Hello World'
});
You can specify the second argument as a callback for getting error and response.
var notifier = require('node-notifier');
notifier.notify({
title: 'My application',
message: 'New notification'
}, function(error, response) {
console.log(response);
});
The response will be given as an object. E.g., when running notifier.notify({list: "ALL"}), this could be the response:
{ response:
[ { GroupID: null,
Title: 'Terminal',
Subtitle: null,
Message: 'Another message',
'Delivered At': Wed Dec 12 2012 15:23:38 GMT+0100 (CET) },
{ GroupID: null,
Title: 'Terminal',
Subtitle: null,
Message: 'Another message',
'Delivered At': Wed Dec 12 2012 15:23:31 GMT+0100 (CET) },
{ GroupID: 2,
Title: 'Terminal',
Subtitle: null,
Message: 'Testing',
'Delivered At': Wed Dec 12 2012 15:22:41 GMT+0100 (CET) },
{ GroupID: 1,
Title: 'Terminal',
Subtitle: null,
Message: 'Testing',
'Delivered At': Wed Dec 12 2012 15:22:29 GMT+0100 (CET) } ],
type: 'list' }
There are three different types:
deliviered when a message is delivered.removed when all or one message is removed. If all messages are removed, the response property will have several elements.list when a list is presented. Even when doing list: 1.When these criterias are met, the module will be versioned 1.0.
NB: Previous plans of supporting both growlnotify and terminal-notifier, are abandoned. This module will only do terminal-notifier.
FAQs
A Node.js module for sending notifications on native Mac, Windows (post and pre 8) and Linux (or Growl as fallback)
The npm package node-notifier receives a total of 4,975,357 weekly downloads. As such, node-notifier popularity was classified as popular.
We found that node-notifier demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.