@types/progress-bar-webpack-plugin/README.md

TypeScript definitions for progress-bar-webpack-plugin

# Installation
> `npm install --save @types/progress-bar-webpack-plugin`

# Summary
This package contains type definitions for progress-bar-webpack-plugin (https://github.com/clessg/progress-bar-webpack-plugin#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/progress-bar-webpack-plugin.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/progress-bar-webpack-plugin/index.d.ts)
````ts
import * as ProgressBar from "progress";
import { Plugin } from "webpack";

export = ProgressBarPlugin;

declare namespace ProgressBarPlugin {
    interface Options extends ProgressBar.ProgressBarOptions {
        /**
         * the format of the progress bar
         * @default ':bar'
         */
        format?: string | undefined;
        /**
         * optional function to call when the progress bar completes
         */
        callback?: (() => void) | undefined;
        /**
         * option to show summary of time taken
         * @default true
         */
        summary?: boolean | undefined;
        /**
         * custom summary message if summary option is false
         */
        summaryContent?: boolean | undefined;
        /**
         * function to display a custom summary
         * (passed build time)
         */
        customSummary?: ((summary: string) => void) | undefined;
    }
}

/**
 * A progress bar plugin for Webpack.
 */
declare class ProgressBarPlugin extends Plugin {
    constructor(options?: ProgressBarPlugin.Options);
}

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: [@types/progress](https://npmjs.com/package/@types/progress), [@types/webpack](https://npmjs.com/package/@types/webpack)

# Credits
These definitions were written by [Piotr Błażejewicz (Peter Blazejewicz)](https://github.com/peterblazejewicz).