A Node.js module for sending notifications on native Mac, Windows (post and pre 8) and Linux (or Growl as fallback). 

A Node.js module for sending notifications on native Mac, Windows (post and pre 8) and Linux (or Growl as fallback)

mikaelb

node-notifier

- fixes possible injection issue for notify-send

- Expire time for notify-send is made to match macOS and Windows with default time of 10 seconds. The API is changed to take seconds as input and converting it to milliseconds before passing it on to notify-send. See [#341](https://github.com/mikaelbr/node-notifier/pull/341).

- Fixes issue with haning Windows notifications when disabled ([#335](https://github.com/mikaelbr/node-notifier/pull/335))

- Fixes import of uuid, removes deprecation warnings

- NotifySend support for app-name ([#299](https://github.com/mikaelbr/node-notifier/pull/299), see docs)

- All notify messages now have auto bound context to make it easier to pass as variables/arguments ([#306](https://github.com/mikaelbr/node-notifier/pull/306))

- Updated snoreToast to version `0.7.0` with new input features ([#293](https://github.com/mikaelbr/node-notifier/pull/293))

- Breaking snoreToast: Sanitizing data now changes "timedout" to "timeout"

- Dropped support for node v6. As of v6 we currently support node versions 8, 10, and 12 (latest).

- Updated to the latest version of SnoreToast. This removes support for the `wait` option in that environment as it is now always on. Prepares the way for other new features added to the WindowsToaster.

- Update to latest version of dependencies.

- Reverts breaking dependency upgrades from `v5.4.2` as some dependencies has removed Node 6 which is a breaking change.

- Reverts changes to default timeout as they are causing some issues. See [#271](https://github.com/mikaelbr/node-notifier/pull/271)

- Prevent Spotlight from indexing terminal-notifier.app ([#238](https://github.com/mikaelbr/node-notifier/pull/238))

- Adds default timeout to notification center

- Adds mapping from timeout to expire time for linux

- Enables the use of WindowsToaster when using WSL ([#260](https://github.com/mikaelbr/node-notifier/pull/260))

- Rollback `notifu` update as it triggered Avast virus scan.

- Updates `terminal-notifier` dependency to `v1.7.2`, fixing memory leak. But not to `v1.8.0` as this breaks how icons work.

- Updates `notifu` with new subtitle "Notification"

- Fix: issue with `appID` by removing default empty string (see README Windows section)

- Fix: link notifier time property to notify-send expire-time flag

- Minor change: use a more specific condition for enabling debug logging ([#171](https://github.com/mikaelbr/node-notifier/pull/171))

- Adds temporary workaround for `terminal-notifier` memory leak as seen in https://github.com/facebook/jest/issues/2999 and https://github.com/julienXX/terminal-notifier/issues/173.

- Add appName option and hide snoreToast if not setted ([#158](https://github.com/mikaelbr/node-notifier/pull/158))

Non-obligatory fail. Fixes issue with multiple actions for macOS.

Obligatory fail. Fixes minor issue with non-JSON output for macOS.

_Note/TL;DR_: If you are just using `node-notifier` with things like `message`, `title` and `icon`, v5 should work just as before.

1.  CLI is now removed. Can be found in separate project: https://github.com/mikaelbr/node-notifier-cli. This means you no longer get the `notify` bin when installing `node-notifier`. To get this do `npm i [-g] node-notifier-cli`

2.  Changed toaster implementation from `toast.exe` to [Snoretoast](https://github.com/KDE/snoretoast). This means if you are using your custom fork, you need to change. SnoreToast has some better default implemented functionality.

3.  [terminal-notifier](https://github.com/julienXX/terminal-notifier) dependency has been bumped to `v1.7.1`. With that there can be changes in the API, and supports now reply and buttons. Output has changed to JSON by default, this means the output of some functions of the terminal-notifier has broken. See https://github.com/julienXX/terminal-notifier for more details. See [README](https://github.com/mikaelbr/node-notifier#usage-notificationcenter) for documentation on how to use the new features, or [an example file](https://github.com/mikaelbr/node-notifier/blob/master/example/macInput.js).

4.  `notify` method will now throw error if second argument is something else than function (still optional): [#138](https://github.com/mikaelbr/node-notifier/pull/138).

  return JSON.parse(JSON.stringify(obj));

    return str.replace(/(["$`\\])/g, '\\$1');

module.exports.command = function (notifier, options, cb) {

  notifier = shellwords.escape(notifier);

  if (process.env.DEBUG && process.env.DEBUG.indexOf('notifier') !== -1) {

    console.info('node-notifier debug info (command):');

    console.info('[notifier path]', notifier);

    console.info('[notifier options]', options.join(' '));

  return cp.exec(notifier + ' ' + options.join(' '), function (

module.exports.fileCommand = function (notifier, options, cb) {

    console.info('node-notifier debug info (fileCommand):');

  return cp.execFile(notifier, options, function (error, stdout, stderr) {

module.exports.fileCommandJson = function (notifier, options, cb) {

    console.info('node-notifier debug info (fileCommandJson):');

      (!checkForAllowed || inArray(allowedArguments, key))

      if (explicitTrue && options[key] === true) {

      } else if (explicitTrue && options[key] === false) continue;

      else args.push('-' + keyExtra + key, escapeFn(options[key]));

  var excapedNewline = process.platform === 'win32' ? '\\r\\n' : '\\n';

  return str.replace(/\r?\n/g, excapedNewline);

[-t] <title string>     | Displayed on the first line of the toast.

[-m] <message string>   | Displayed on the remaining lines, wrapped.

[-b] <button1;button2 string>| Displayed on the bottom line, can list multiple buttons separated by ";"

[-tb]                   | Displayed a textbox on the bottom line, only if buttons are not presented.

[-p] <image URI>        | Display toast with an image, local files only.

[-id] <id>              | sets the id for a notification to be able to close it later.

[-s] <sound URI>        | Sets the sound of the notifications, for possible values see http://msdn.microsoft.com/en-us/library/windows/apps/hh761492.aspx.

[-silent]               | Don't play a sound file when showing the notifications.

[-appID] <App.ID>       | Don't create a shortcut but use the provided app id.

[-pid] <pid>            | Query the appid for the process <pid>, use -appID as fallback. (Only relevant for applications that might be packaged for the store)

[-pipeName] <\.\pipe\pipeName\> | Provide a name pipe which is used for callbacks.

[-application] <C:\foo.exe>     | Provide a application that might be started if the pipe does not exist.

-close <id>             | Closes a currently displayed notification.

var toasterSoundPrefix = 'Notification.';

var toasterDefaultSound = 'Notification.Default';

module.exports.mapToWin8 = function (options) {

    if (/^file:\/+/.test(options.icon)) {

      // should parse file protocol URL to path

      options.p = new url.URL(options.icon).pathname

    // Remove escape char to debug "HRESULT : 0xC00CE508" exception

    options.m = options.message.replace(/\x1b/g, '');

  if (typeof options.remove !== 'undefined') {

    options.silent = options.quiet || options.silent;

  if (typeof options.sound !== 'undefined') {

  "description": "A Node.js module for sending notifications on native Mac, Windows (post and pre 8) and Linux (or Growl as fallback)",

    "example": "node ./example/message.js",

    "example:mac": "node ./example/advanced.js",

    "example:mac:input": "node ./example/macInput.js",

    "example:windows": "node ./example/toaster.js",

    "example:windows:actions": "node ./example/toaster-with-actions.js",

    "lint": "eslint example/*.js lib/*.js notifiers/*.js test/**/*.js index.js"

    "url": "git+ssh://git@github.com/mikaelbr/node-notifier.git"

    "eslint-config-semistandard": "^15.0.1",

    "url": "https://github.com/mikaelbr/node-notifier/issues"

  "homepage": "https://github.com/mikaelbr/node-notifier#readme",

		# Changelog

		### `v8.0.1`

		- fixes possible injection issue for notify-send

		### `v8.0.0`
		@@ -4,0 +8,0 @@

		@@ -316,3 +316,5 @@ var shellwords = require('shellwords');
		initial.forEach(function (val) {
		args.push(escapeFn(val));
		if (typeof val === 'string') {
		args.push(escapeFn(val));
		}
		});
		@@ -319,0 +321,0 @@ for (var key in options) {

		{
		"name": "node-notifier",
		"version": "8.0.0",
		"version": "8.0.1",
		"description": "A Node.js module for sending notifications on native Mac, Windows (post and pre 8) and Linux (or Growl as fallback)",
		@@ -5,0 +5,0 @@ "main": "index.js",

Improved metrics