Logo for jsDocs.io

@types/webpackbar

  • Version 4.0.6
  • Published
  • 6.01 kB
  • 2 dependencies
  • MIT license

Install

npm i @types/webpackbar
yarn add @types/webpackbar
pnpm add @types/webpackbar

Overview

TypeScript definitions for webpackbar

Index

Classes

Interfaces

Type Aliases

Classes

class WebpackBar

class WebpackBar extends ProgressPlugin {}

  • Elegant ProgressBar and Profiler for Webpack

constructor

constructor(options?: WebpackBar.Options);

    property state

    readonly state: WebpackBar.Status;

      Interfaces

      interface Options

      interface Options {}

        property basic

        basic?: boolean | undefined;

        • Enable a simple log reporter (only start and end) Defaults to 'true' when running in minimal environments true

        property color

        color?: string | undefined;

        • Color output of the progress bar 'green'

        property fancy

        fancy?: boolean | undefined;

        • Enable bars reporter Defaults to 'true' when not in CI or testing mod true

        property name

        name?: string | undefined;

        • Display name 'webpack'

        property profile

        profile?: boolean | undefined;

        • Enable profiler false

        property reporter

        reporter?: Reporter | null | undefined;

        • Register a custom reporter null

        property reporters

        reporters?: string[] | undefined;

        • Register an Array of your custom reporters. ['basic'] | ['fancy']

        interface Reporter

        interface Reporter {}

        • If you plan to provide your own reporter, don't forget to setting fancy and basic options to false to prevent conflicts. A reporter should be instance of a class or plain object and functions for special hooks. It is not necessary to implement all functions, webpackbar only calls those that exists

        property afterAllDone

        afterAllDone?: ReporterContextFunc | undefined;

          property allDone

          allDone?: ReporterContextFunc | undefined;

          • Called when _all_ compiles finished

          property beforeAllDone

          beforeAllDone?: ReporterContextFunc | undefined;

            property change

            change?: ReporterContextFunc | undefined;

            • Called when a file changed on watch mode

            property done

            done?: ReporterContextFunc | undefined;

            • Called when compile finished

            property progress

            progress?: ReporterContextFunc | undefined;

            • Called when build progress updated

            property start

            start?: ReporterContextFunc | undefined;

            • Called when (re)compile is started

            property update

            update?: ReporterContextFunc | undefined;

            • Called after each progress update

            interface Status

            interface Status {}

              property color

              readonly color: string;

                property details

                readonly details: string[];

                  property done

                  readonly done: boolean;

                  • false

                  property hasErrors

                  readonly hasErrors: boolean;

                  • false

                  property message

                  readonly message: string;

                  • ''

                  property name

                  readonly name: string;

                    property progress

                    readonly progress: number;

                    • -1

                    property request

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

                      property start

                      readonly start: [number, number] | null;

                      • null

                      Type Aliases

                      type ReporterContextFunc

                      type ReporterContextFunc = (context: WebpackBar) => void;

                      • 'context' is the reference to the plugin You can use 'context.state' to access status

                      Package Files (1)

                      Dependencies (2)

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

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