Logo for jsDocs.io

webpack-notifier

  • Version 1.15.0
  • Published
  • 21.2 kB
  • 2 dependencies
  • ISC license

Install

npm i webpack-notifier
yarn add webpack-notifier
pnpm add webpack-notifier

Overview

webpack + node-notifier = build status system notifications

Index

Classes

Interfaces

Type Aliases

Classes

class WebpackNotifierPlugin

class WebpackNotifierPlugin {}

    constructor

    constructor(options?: WebpackNotifierPlugin.Options);

      method apply

      apply: (compiler: Compiler) => void;

        Interfaces

        interface Options

        interface Options {}

          property alwaysNotify

          alwaysNotify?: boolean;

            property contentImage

            contentImage?: { [key in 'success' | 'warning' | 'error']: string } | string;

              property emoji

              emoji?: boolean;

              • Use emoji in notifications

              property excludeWarnings

              excludeWarnings?: boolean;

                property onlyOnError

                onlyOnError?: boolean;

                  property skipFirstNotification

                  skipFirstNotification?: boolean;

                    property title

                    title?: string | TitleGetter;

                      Type Aliases

                      type Config

                      type Config = Options;

                      • Deprecated

                        use Options

                      type TitleGetter

                      type TitleGetter = (data: {
                          msg: string;
                          message: string;
                          status: string;
                      }) => string;

                        Package Files (1)

                        Dependencies (2)

                        Dev Dependencies (19)

                        Peer Dependencies (1)

                        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/webpack-notifier.

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