@types/progress-bar-webpack-plugin v2.1.5

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

// Type definitions for progress-bar-webpack-plugin 2.1
// Project: https://github.com/clessg/progress-bar-webpack-plugin#readme
// Definitions by: Piotr Błażejewicz (Peter Blazejewicz) <https://github.com/peterblazejewicz>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 3.7

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: Thu, 08 Jul 2021 20:19:51 GMT
• Dependencies: @types/webpack, @types/progress
• Global values: none

Credits

These definitions were written by Piotr Błażejewicz (Peter Blazejewicz).