Options
All
  • Public
  • Public/Protected
  • All
Menu

Options object for the ProgressPlugin.

Hierarchy

  • ProgressPluginOptions

Index

Properties

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.

modules?: boolean

Show modules count in progress message.

modulesCount?: number

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

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

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

profile?: null | boolean

Collect profile data for progress steps. Default: false.

Methods

  • handler(percentage: number, msg: string, ...args: string[]): void
  • Function that executes for every progress step.

    Parameters

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

    Returns void