Interface ProgressPluginOptions

Options object for the ProgressPlugin.

Hierarchy

  • ProgressPluginOptions

Properties

activeModules? dependencies? dependenciesCount? entries? handler? modules? modulesCount? percentBy? profile?

Properties

Optional activeModules

activeModules?: boolean

Show active modules count and one active module in progress message.

Optional dependencies

dependencies?: boolean

Show dependencies count in progress message.

Optional dependenciesCount

dependenciesCount?: number

Minimum dependencies count to start with. For better progress calculation. Default: 10000.

Optional entries

entries?: boolean

Show entries count in progress message.

Optional handler

handler?: ((percentage, msg, ...args) => void)

Type declaration

    • (percentage, msg, ...args): void

    • Function that executes for every progress step.

      Parameters

      • percentage: number
      • msg: string
      • Rest ...args: string[]

      Returns void

Optional modules

modules?: boolean

Show modules count in progress message.

Optional modulesCount

modulesCount?: number

Minimum modules count to start with. For better progress calculation. Default: 5000.

Optional percentBy

percentBy?: null | "modules" | "entries" | "dependencies"

Collect percent algorithm. By default it calculates by a median from modules, entries and dependencies percent.

Optional profile

profile?: null | boolean

Collect profile data for progress steps. Default: false.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc