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

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).

1. Now supports *BSD systems: [#142](https://github.com/mikaelbr/node-notifier/pull/142).

2. With the new toaster implementation you can do more! For instance customize sound and close notification. See all options:

  message: void 0, // String. Required if remove is not defined

  icon: void 0, // String. Absolute path to Icon

  sound: false, // Bool | String (as defined by http://msdn.microsoft.com/en-us/library/windows/apps/hh761492.aspx)

  wait: false, // Bool. Wait for User Action against Notification or times out

  id: void 0, // Number. ID to use for closing notification.

  appID: void 0, // String. App.ID. Don't create a shortcut but use the provided app id.

  remove: void 0, // Number. Refer to previously created notification to close.

  install: void 0 // String (path, application, app id).  Creates a shortcut <path> in the start menu which point to the executable <application>, appID used for the notifications.

1. Fixes new lines on messages on Windows: [#123](https://github.com/mikaelbr/node-notifier/issues/123)

_Internal changes for those who might be interested_.

2. Unnecessary dependencies removed (`lodash.deepClone`). Now uses JSON serialize/deserialize instead.

3. Project is auto-formatted by [`prettier`](https://github.com/jlongster/prettier).

4. [Linting is added](https://github.com/mikaelbr/node-notifier/blob/master/.eslintrc)

5. Added way to better debug what is happening by setting `DEBUG` env-var to `true`. See [CONTRIBUTE.md](https://github.com/mikaelbr/node-notifier/blob/master/CONTRIBUTE.md) for more details.

1. Adds npm ignore file, ignoring tests and examples from package.

1. Adds support for Icon URL in Growl ([by @gucong3000](https://github.com/mikaelbr/node-notifier/pull/115))

2. Adds options for passing host and port to cli tool ([reported by @el-davo](https://github.com/mikaelbr/node-notifier/issues/106))

3. Fixes sanitize response on `notify` callback ([by @MadLittleMods](https://github.com/mikaelbr/node-notifier/commit/a44454a11eff452a8b55f9fbe291e189ed088708))

4. Fixes use of new line in messages ([by @gucong3000](https://github.com/mikaelbr/node-notifier/pull/115))

5. Fixes use of `file:///xxx` protocol icon paths for Windows 8.1 ([by @gucong3000](https://github.com/mikaelbr/node-notifier/pull/118))

6. Fixes non-TTY usage and piping messages ([reported by @simensen](https://github.com/mikaelbr/node-notifier/issues/109))

7. Updates vendor terminal-notifier version to 1.6.3 ([reported by @kid-icarus](https://github.com/mikaelbr/node-notifier/pull/120))

1. Adds syntactic sugar for `notify`. Now able to just pass message:

See [#45](https://github.com/mikaelbr/node-notifier/issues/45) for more info.

2. Updates `semver` dependency to support Webpacking with Electron.

1. Changes to exec terminal-notifier through execFile to allow for asar-packages

3. Adds support for win7 with electron asar-package

1. Adds support for piping messages in to CLI.

(With `node-notifier` installed as a CLI `npm i -g node-notifier`)

➜ echo "Message" | notify -t "My Title"

➜ echo "Some message" | notify -t "My Title" -s

1. Fixed input arguments to CLI to be strings where they should be strings.

1. Fixed no notification when no message for the CLI. [#58](https://github.com/mikaelbr/node-notifier/pull/58)

2. Changes `which` test to be sync, avoiding some edge cases with multiple notifications.

2. Fixes Debug "HRESULT : 0xC00CE508" exception on Win8. PR [#49](https://github.com/mikaelbr/node-notifier/pull/49)

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

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

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

  notifier = shellwords.escape(notifier);

    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):');

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

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

          return '"' + escapeQuotes(current) + '"';

    if (typeof arg === 'string' && !keepNewlines) {

        (!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.

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

[-w]                    | Wait for toast to expire or activate.

[-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.

-close <id>             | Closes a currently displayed notification, in order to be able to close a notification the parameter -w must be used to create the 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 = url.parse(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",

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

    "setupTestFrameworkScriptFile": "./test/_test-matchers.js"

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

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

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

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

		Changelog
		===

		### `v5.0.2`

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

		### `v5.0.1`
		@@ -12,2 +16,4 @@

		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`
		@@ -14,0 +20,0 @@ 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.

		@@ -280,5 +280,3 @@ var shellwords = require('shellwords');
		return removeNewLines(
		arg.map(function(current) {
		return '"' + escapeQuotes(current) + '"';
		}).join(',')
		arg.join(',')
		);
		@@ -285,0 +283,0 @@ }

		{
		"name": "node-notifier",
		"version": "5.0.1",
		"version": "5.0.2",
		"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

Worsened metrics