Introduction to Node Notifier

Node Notifier is a highly useful and versatile library for sending notifications in Node.js applications. Whether you need to notify users on their desktop or send alerts for various application events, Node Notifier provides an extensive set of APIs to make it easy and efficient. In this guide, we will explore dozens of APIs provided by Node Notifier along with comprehensive code snippets to demonstrate their usage in real-world applications.

Setting Up Node Notifier

First, install Node Notifier in your Node.js project using npm or yarn:

  
    npm install node-notifier
  

or

  
    yarn add node-notifier
  

Now, you can import and use Node Notifier in your project:

  
    const notifier = require('node-notifier');
  

Basic Notification

To send a basic notification:

  
    notifier.notify({
      title: 'Notification Title',
      message: 'Hello, this is a fantastic notification!',
    });
  

Customized Notification

You can customize the notification with various options:

  
    notifier.notify({
      title: 'Custom Notification',
      message: 'This is a customized notification!',
      icon: 'path/to/icon.png', // Absolute path (doesn't work on balloons)
      sound: true, // Only Notification Center or Windows Toasters
      wait: true // Wait with callback, until user action is taken against notification
    });
  

Notification with Callback

Node Notifier supports callbacks to handle user interactions:

  
    notifier.notify({
      title: 'Callback Notification',
      message: 'Click to see a callback example!',
      wait: true
    }, function (err, response, metadata) {
      // Response is response from notification
      console.log('Notification Response:', response);
      // Metadata is the information about the notification
      console.log('Notification Metadata:', metadata);
    });
  

Notification with Actions

Notifications can include actions for users to respond to:

  
    notifier.notify({
      title: 'Action Notification',
      message: 'Choose an action!',
      wait: true,
      actions: ['Yes', 'No']
    }, function (err, response, metadata) {
      console.log('Notification Response:', response);
      console.log('Action Chosen:', metadata.activationValue); // 'Yes' or 'No'
    });
  

Close Notification Programmatically

You can also close a notification programmatically after a certain period:

  
    const notification = notifier.notify({
      title: 'Auto-Close Notification',
      message: 'This will close automatically in 5 seconds.'
    });

    setTimeout(() => {
      notification.close();
    }, 5000);
  

MacOS, Windows, and Linux Compatibility

Notifications work across different operating systems with some specific options:

  
    notifier.notify({
      title: 'Cross-Platform Notification',
      message: 'This notification works on MacOS, Windows, and Linux!',
      timeout: 5, // For Linux only
      appID: 'com.myapp.id', // For Windows only, unique ID for your app
    });
  

Example Application

Here is a simple Node.js application that utilizes several Node Notifier APIs:

  
    const notifier = require('node-notifier');

    // Basic Notification
    notifier.notify({
      title: 'App Started',
      message: 'Your app has started successfully.',
    });

    // Customized Notification with Callback
    notifier.notify({
      title: 'App Running',
      message: 'Your app is running smoothly.',
      icon: path.join(__dirname, 'icon.png'),
      sound: true,
      wait: true
    }, (err, response, metadata) => {
      console.log('Notification Response:', response);
      console.log('Notification Metadata:', metadata);
    });

    // Action Notification
    notifier.notify({
      title: 'User Action Required',
      message: 'Do you want to continue?',
      wait: true,
      actions: ['Yes', 'No']
    }, (err, response, metadata) => {
      if (metadata.activationValue === 'Yes') {
        console.log('User chose to continue.');
      } else {
        console.log('User chose not to continue.');
      }
    });

    // Auto-close Notification
    const notification = notifier.notify({
      title: 'Goodbye Notification',
      message: 'This will close automatically in 10 seconds.'
    });

    setTimeout(() => {
      notification.close();
    }, 10000);
  

With Node Notifier’s powerful API, you can create a wide range of notifications tailored to your application’s needs. Explore the extensive documentation and start integrating notifications into your Node.js projects today!

Hash: 99f7220fee078386924629cd32ab2e07b831d20acd8fde8c42c453691eb23be0