Logo for jsDocs.io

webpackbar

  • Version 6.0.1
  • Published
  • 50.2 kB
  • 8 dependencies
  • MIT license

Install

npm i webpackbar
yarn add webpackbar
pnpm add webpackbar

Overview

Elegant ProgressBar and Profiler for Webpack

Index

Classes

Interfaces

Classes

class WebpackBarPlugin

class WebpackBarPlugin extends Webpack.ProgressPlugin {}

    constructor

    constructor(options?: WebpackBarOptions);

      property hasErrors

      readonly hasErrors: boolean;

        property hasRunning

        readonly hasRunning: boolean;

          property state

          readonly state: State;

            property states

            readonly states: { [key: string]: State };

              property statesArray

              readonly statesArray: any[];

                method apply

                apply: (compiler: any) => void;

                  method callReporters

                  callReporters: (fn: any, payload?: {}) => void;

                    method updateProgress

                    updateProgress: (percent?: number, message?: string, details?: any[]) => void;

                      Interfaces

                      interface Reporter

                      interface Reporter {}

                        property afterAllDone

                        afterAllDone?: ReporterContextFunc;

                          property allDone

                          allDone?: ReporterContextFunc;

                          • Called when _all_ compiles finished

                          property beforeAllDone

                          beforeAllDone?: ReporterContextFunc;

                            property change

                            change?: ReporterContextFunc<{ shortPath: string }>;

                            • Called when a file changed on watch mode

                            property done

                            done?: ReporterContextFunc<{ stats: Stats }>;

                            • Called when compile finished

                            property progress

                            progress?: ReporterContextFunc;

                            • Called when build progress updated

                            property start

                            start?: ReporterContextFunc;

                            • Called when (re)compile is started

                            property update

                            update?: ReporterContextFunc;

                            • Called after each progress update

                            interface State

                            interface State {}

                              property color

                              color: string;

                                property details

                                details: string[];

                                  property done

                                  done: boolean;

                                    property hasErrors

                                    hasErrors: boolean;

                                      property message

                                      message: string;

                                        property name

                                        name: string;

                                          property progress

                                          progress: number;

                                            property request

                                            request: null | {
                                                file: null | string;
                                                loaders: string[];
                                            };

                                              property start

                                              start: [number, number] | null;

                                                Package Files (1)

                                                Dependencies (8)

                                                Dev Dependencies (13)

                                                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/webpackbar.

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