Logo for jsDocs.io

node-notifier

  • Version 12.1.0
  • Published
  • 6.15 MB
  • 2 dependencies
  • MIT license

Install

npm i node-notifier
yarn add node-notifier
pnpm add node-notifier

Overview

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

Index

Variables

Interfaces

Variables

variable Notification

const Notification: NotifierClass;

  • The notifier class picked for the current platform.

variable notifier

const notifier: DefaultNotifier;

  • A ready-to-use instance of the notifier for the current platform.

variable notify

const notify: (
    notification?: string | AnyNotification,
    callback?: NotificationCallback
) => Notifier$2<Notification>;

  • notify of the default instance, bound so it can be used on its own.

Interfaces

interface DefaultNotifier

interface DefaultNotifier extends Notifier$2<AnyNotification> {}

  • The default notifier, with all notifier classes attached.

property Growl

Growl: typeof Notifier;

    property Notification

    Notification: NotifierClass;

      property NotificationCenter

      NotificationCenter: typeof Notifier$1;

        property NotifySend

        NotifySend: typeof Notifier$3;

          property WindowsBalloon

          WindowsBalloon: typeof Notifier$4;

            property WindowsToaster

            WindowsToaster: typeof Notifier$5;

              Package Files (1)

              Dependencies (2)

              Dev Dependencies (8)

              Peer Dependencies (0)

              No peer dependencies.

              Badge

              To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

              You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/node-notifier.

              • Markdown
                [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/node-notifier)
              • HTML
                <a href="https://www.jsdocs.io/package/node-notifier"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>