On this page

new ProgressPlugin(options?): ProgressPlugin
Attributes
options:<ProgressPluginArgument>
options
Returns:<ProgressPlugin>

Creates an instance of ProgressPlugin.

Attributes
dependenciesCount:<number>
handler:
(percentage: <number> , msg: <string> , args: <string> []) => <void>
modulesCount:<number>
options:<ProgressPluginOptions>
percentBy:
<"entries"> | <"dependencies"> | <"modules"> | <null>
profile:<boolean> | <null>
progressBar:
{false | Required<{ color?: string; name?: string }>}
showActiveModules:<boolean>
showDependencies:<boolean>
showEntries:<boolean>
showModules:<boolean>
createDefaultHandler:
{(profile: boolean | null | undefined, logger: WebpackLogger, progressBar?: false | Required<{ color?: string; name?: string }>) => (percentage: number, msg: string, args: string[]) => void} Creates a default handler.
defaultOptions:
<Required> < <Omit> < <ProgressPluginOptions> , <"handler"> >>
apply(compiler): void
Attributes
compiler:<Compiler> | <MultiCompiler>
webpack compiler
Returns:<void>

Applies the plugin by registering its hooks on the compiler.

Attributes
compiler:<Compiler>
the current compiler
Returns:
(p: <number> , args: <string> []) => <void> | <undefined> a progress reporter, if any

Returns a progress reporter, if any.

Type:<ProgressPluginOptions>
| (percentage: <number> , msg: <string> , args: <string> []) => <void>

Options object for the ProgressPlugin.

Attributes
activeModules:<boolean>
Show active modules count and one active module in progress message.
dependencies:<boolean>
Show dependencies count in progress message.
dependenciesCount:<number>
Minimum dependencies count to start with. For better progress calculation. Default: 10000.
entries:<boolean>
Show entries count in progress message.
handler:
(percentage: <number> , msg: <string> , args: <string> []) => <void> Function that executes for every progress step.
modules:<boolean>
Show modules count in progress message.
modulesCount:<number>
Minimum modules count to start with. For better progress calculation. Default: 5000.
percentBy:
<"entries"> | <"dependencies"> | <"modules"> | <null> Collect percent algorithm. By default it calculates by a median from modules, entries and dependencies percent.
profile:<boolean> | <null>
Collect profile data for progress steps. Default: false.
progressBar:
{boolean | { color?: string; name?: string }} Generate progress bar. Default: false.