@types/node-notifier

  • Version 8.0.1
  • Published
  • 10.9 kB
  • 1 dependency
  • MIT license

Install

npm i @types/node-notifier
yarn add @types/node-notifier
pnpm add @types/node-notifier

Overview

TypeScript definitions for node-notifier

Index

Variables

variable nodeNotifier

var nodeNotifier: nodeNotifier.NodeNotifier;

    Interfaces

    interface NodeNotifier

    interface NodeNotifier extends NodeJS.EventEmitter {}

      property Growl

      Growl: typeof Growl;

        property NotificationCenter

        NotificationCenter: typeof NotificationCenter;

          property NotifySend

          NotifySend: typeof NotifySend;

            property WindowsBalloon

            WindowsBalloon: typeof WindowsBalloon;

              property WindowsToaster

              WindowsToaster: typeof WindowsToaster;

                method notify

                notify: {
                (
                notification?: NotificationCenter.Notification,
                callback?: NotificationCallback
                ): NotificationCenter;
                (
                notification?: WindowsToaster.Notification,
                callback?: NotificationCallback
                ): WindowsToaster;
                (
                notification?: WindowsBalloon.Notification,
                callback?: NotificationCallback
                ): WindowsBalloon;
                (
                notification?: NotifySend.Notification,
                callback?: NotificationCallback
                ): NotifySend;
                (notification?: Growl.Notification, callback?: NotificationCallback): Growl;
                (
                notification?: string | Notification,
                callback?: NotificationCallback
                ): NodeNotifier;
                };

                  interface Notification

                  interface Notification {}

                    property icon

                    icon?: string | undefined;
                    • Absolute path (not balloons)

                    property message

                    message?: string | undefined;

                      property title

                      title?: string | undefined;

                        property wait

                        wait?: boolean | undefined;
                        • Wait with callback until user action is taken on notification

                        interface NotificationCallback

                        interface NotificationCallback {}

                          call signature

                          (err: Error | null, response: string, metadata?: NotificationMetadata): void;

                            interface NotificationMetadata

                            interface NotificationMetadata {}

                              property activationAt

                              activationAt?: string | undefined;

                                property activationType

                                activationType?: string | undefined;

                                  property activationValue

                                  activationValue?: string | undefined;

                                    property activationValueIndex

                                    activationValueIndex?: string | undefined;

                                      property deliveredAt

                                      deliveredAt?: string | undefined;

                                        interface Option

                                        interface Option {}

                                          property customPath

                                          customPath?: string | undefined;

                                            property withFallback

                                            withFallback?: boolean | undefined;

                                              Package Files (1)

                                              Dependencies (1)

                                              Dev Dependencies (0)

                                              No dev dependencies.

                                              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/@types/node-notifier.

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