On this page

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

Creates an instance of ProgressPlugin.

Attributes
dependenciesCount:number
estimatedTime:boolean
handler:(percentage: number, msg: string, args: string[]) => void
modulesCount:number
options:ProgressPluginOptions
percentBy:"entries" | "dependencies" | "modules" | null
phaseTimings:boolean
profile:boolean | null
progressBar:false | "auto" | Required<{ color?: string; name?: string; width?: number }>
showActiveModules:boolean
showDependencies:boolean
showEntries:boolean
showModules:boolean
createDefaultHandler:(profile: boolean | null | undefined, logger: WebpackLogger, options?: DefaultHandlerOptions) => (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.

Attributes
estimatedTime:boolean
phaseTimings:boolean
progressBar:false | Required<{ color?: string; name?: string; width?: number }>
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.
estimatedTime:boolean
Show estimated time remaining based on build progress. Default: false.
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.
phaseTimings:boolean
Show a timing breakdown for each build phase when the build completes. Default: false.
profile:boolean | null
Collect profile data for progress steps. Default: false.
progressBar:boolean | "auto" | { color?: string; name?: string; width?: number }
Generate progress bar. "auto" enables it only for interactive terminals. Default: false.