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

Error

Ignore

Warn

License

Maintenance

Miscellaneous

Quality

Supply chain risk

Vulnerability

Admins only

Organization members

Dashboard

<upgradeLink>Upgrade</upgradeLink> to access this feature

About

Blog

Socket CLI

Customers

Socket Dependency Search

Docs

Socket for GitHub

Love

Impersonation Mode Active

Update your browser to the latest version for the best experience.

Your web browser is outdated

Use another browser for the best experience.

Your web browser is unsupported

{{count, number}} commits last two months

{{count, number}} critical severity alert

{{count, number}} critical severity alerts

{{count, number}} dependency vulnerability

{{count, number}} dependency vulnerabilities

{{count, number}} development dependencies

{{count, number}} transitive dependencies

{{count, number}} version published last month

{{count, number}} versions published last month

{{count, number}} version published in last two months

{{count, number}} versions published in last two months

{{count, number}} version published last week

{{count, number}} versions published last week

{{count, number}} version published last year

{{count, number}} versions published last year

Socket undergoes annual SOC2 Type II audits. Socket customers can request a copy of the full SOC2 Type II report.

Allows organization owners and admins to access detailed records of actions taken by members of their organization, complete with timestamps.

Prevent compromised packages from infiltrating your supply chain by monitoring for changes in real-time.

Join our Discord community to get help from Socket engineers and other Socket users.

Compare millions of open source packages on socket.dev

Detect malicious code and risky behavior (e.g. network) in your dependencies using "deep package inspection"

All data is encrypted in transit and at rest using industry standard encryption algorithms.

Get a dedicated Socket account manager and access to Socket’s Customer Success team.

Get dedicated support from Socket engineers via email and Slack.

"Shift left" with the Socket Chrome extension and give intervene early, before developers choose risky or low quality dependencies.

Catch developers using risky dependencies and give them a "speed bump" to encourage good behavior

Install the Socket GitHub app to receive real-time dependency scanning and reports with every pull request.

Integrate Socket into your GitHub SCM to prevent risky dependencies from being installed.

Socket scans for vulnerabilities in your dependencies, including CVEs, security advisories, and more.

Socket supports dependencies in many languages, with most popular ecosystems coming in 2024. We've got you covered no matter what languages you use.

Enforce license policies across your organization

Receive a Microsoft Teams message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Get help migrating from Socket's free plan to Socket's paid plans.

Run Socket on-premises or in your own cloud environment.

Query for any dependency (at any version) across your entire organization

Integrate Socket into your CI/CD pipeline to prevent risky dependencies from being deployed to production.

Analyze an entire project to find supply chain risks

Tag projects to organize and filter your projects

Restrict access based on the roles of individual users within an organization.

Receive a Slack message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket is SOC2 Type II compliant and undergoes annual audits.

The Socket CLI allows teams to prevent risky dependencies from being installed, and to get dependency insights from the command line.

Socket supports SAML SSO for single sign-on and identity management.

Integrate Socket into your VS Code IDE to prevent risky dependencies from being installed.

Get a POST request anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket will analyzed your SBOMs up to a maximum number of dependencies.

API that allows you to analyze a project, lookup package scores and alerts, and more.

Create API tokens to authenticate with the Socket API and CLI.

The number of developers in your team. A developer is someone who made a commit to your organization's repositories scanned by Socket in the past month.

Use Socket to protect your private repositories.

Socket is always free for open source projects.

Socket retains all reporting data for 3 months, 1 year, or a custom term of your choice.

Access the threat feed that powers Socket.

Unlimited scale, self-hosting, and priority support for large teams.

For open-source projects, individuals, and small teams.

For growing teams with enhanced scale, security, and support.

There is a package with a similar name that is downloaded much more often.

There are packages with similar names that are downloaded much more often.

This may not be the package you want!

Instance

Alert Locations

Package

The {{ecosystem}} package {{- packageName}} receives a total of <strong>{{numWeeklyDownloadCount, number}}</strong> weekly downloads. As such, {{- packageName}} popularity was classified as <strong>{{popularity}}</strong>.

Is {{- packageName}} popular?

Is {{- packageName}} safe to use?

Is {{- packageName}} well maintained?

What is {{- packageName}}?

{{packageDescription}}Version: {{versionString}} was published by {{publisherName}}. Start using Socket to analyze {{- packageName}} and its {{dependencyCount, number}} dependencies to secure your app from supply chain attacks.

Sorry, it seems this package was removed from the registry

Package was removed

This package version has been unpublished, mostly likely due to security reasons

Package version was removed

Provide a detailed description of the malware...

Socket fights vulnerabilities and provides visibility, defense-in-depth, and proactive supply chain protection for JavaScript, Python, and Go dependencies.

Socket - Secure your dependencies. Ship with confidence.

Compare versions

{{- packageName}} - npm Package Compare versions

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

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

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

  if (!options.wait && !options.timeout) {

  return Object.prototype.toString.call(arr) === '[object Array]';

module.exports.actionJackerDecorator = function(emitter, options, fn, mapper) {

      'The second argument must be a function callback. You have passed ' +

    // Allow for extra data if resultantData is an object

    if (resultantData && typeof resultantData === 'object') {

      resultantData = resultantData.activationType;

      resultantData = resultantData.toLowerCase().trim();

      if (resultantData.match(/^activate|clicked$/)) {

    fn.apply(emitter, [err, resultantData, metadata]);

    if (!mapper || !resultantData) return;

    emitter.emit(key, emitter, options, metadata);

module.exports.constructArgumentList = function(options, extra) {

  var allowedArguments = extra.allowedArguments || [];

  var noEscape = extra.noEscape !== void 0;

  var checkForAllowed = extra.allowedArguments !== void 0;

  var explicitTrue = !!extra.explicitTrue;

  var keepNewlines = !!extra.keepNewlines;

  var wrapper = extra.wrapper === void 0 ? '"' : extra.wrapper;

      return removeNewLines(arg.join(','));

    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.

  "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": "^13.0.0",

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

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

# node-notifier [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url]

Send cross platform native notifications using Node.js. Notification Center for macOS,

`notify-osd`/`libnotify-bin` for Linux, Toasters for Windows 8/10, or taskbar balloons for

earlier Windows versions. Growl is used if none of these requirements are met.

[Works well with Electron](#within-electron-packaging).

![macOS Screenshot](https://raw.githubusercontent.com/mikaelbr/node-notifier/master/example/mac.png)

![Native Windows Screenshot](https://raw.githubusercontent.com/mikaelbr/node-notifier/master/example/windows.png)

## Input Example macOS Notification Center

![Input Example](https://raw.githubusercontent.com/mikaelbr/node-notifier/master/example/input-example.gif)

Show a native notification on macOS, Windows, Linux:

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

- **macOS**: >= 10.8 for native notifications, or Growl if earlier.

- **Linux**: `notify-osd` or `libnotify-bin` installed (Ubuntu should have this by default)

- **Windows**: >= 8, or task bar balloons for Windows < 8. Growl as fallback. Growl takes precedence over Windows balloons.

See [documentation and flow chart for reporter choice](./DECISION_FLOW.md).

## <abbr title="Command Line Interface">CLI</abbr>

<abbr title="Command Line Interface">CLI</abbr> has moved to separate project:

<https://github.com/mikaelbr/node-notifier-cli>

Standard usage, with cross-platform fallbacks as defined in the

[reporter flow chart](./DECISION_FLOW.md). All of the options

below will work in some way or another on all platforms.

    message: 'Hello from node, Mr. User!',

    icon: path.join(__dirname, 'coulson.jpg'), // 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

    // Response is response from notification

notifier.on('click', function(notifierObject, options) {

notifier.on('click', function(notifierObject, options, event) {

  // Triggers if `wait: true` and user clicks notification

notifier.on('timeout', function(notifierObject, options) {

  // Triggers if `wait: true` and notification closes

If you want super fine-grained control, you can customize each reporter individually,

allowing you to tune specific options for different systems.

See below for documentation on each reporter.

const NotificationCenter = require('node-notifier/notifiers/notificationcenter');

new NotificationCenter(options).notify();

const NotifySend = require('node-notifier/notifiers/notifysend');

		@@ -213,6 +213,2 @@ var shellwords = require('shellwords');

		if (!options.wait && !options.timeout) {
		options.timeout = 10;
		}

		options.json = true;
		@@ -219,0 +215,0 @@ return options;

		{
		"name": "node-notifier",
		"version": "5.4.0",
		"version": "5.4.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",

New alerts

Fixed alerts

Improved metrics

Worsened metrics

		@@ -74,3 +74,3 @@ # node-notifier [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url]

		notifier.on('click', function(notifierObject, options) {
		notifier.on('click', function(notifierObject, options, event) {
		// Triggers if `wait: true` and user clicks notification
		@@ -77,0 +77,0 @@ });