2023-12-18 13:12:25 +08:00
|
|
|
/**
|
|
|
|
* This file was automatically generated.
|
|
|
|
* DO NOT MODIFY BY HAND.
|
|
|
|
* Run `yarn special-lint-fix` to update
|
|
|
|
*/
|
|
|
|
|
|
|
|
export type ProgressPluginArgument = ProgressPluginOptions | HandlerFunction;
|
|
|
|
/**
|
|
|
|
* Function that executes for every progress step
|
|
|
|
*/
|
2024-01-16 21:26:16 +08:00
|
|
|
export type HandlerFunction = (
|
2023-12-18 13:12:25 +08:00
|
|
|
percentage: number,
|
|
|
|
msg: string,
|
|
|
|
...args: string[]
|
2024-01-16 21:26:16 +08:00
|
|
|
) => void;
|
2023-12-18 13:12:25 +08:00
|
|
|
|
|
|
|
export interface ProgressPluginOptions {
|
|
|
|
/**
|
|
|
|
* Show active modules count and one active module in progress message
|
|
|
|
*/
|
|
|
|
activeModules?: boolean;
|
|
|
|
/**
|
|
|
|
* Show entries count in progress message
|
|
|
|
*/
|
|
|
|
entries?: boolean;
|
|
|
|
/**
|
|
|
|
* Function that executes for every progress step
|
|
|
|
*/
|
|
|
|
handler?: HandlerFunction;
|
|
|
|
/**
|
|
|
|
* Show modules count in progress message
|
|
|
|
*/
|
|
|
|
modules?: boolean;
|
|
|
|
/**
|
|
|
|
* Minimum modules count to start with. Only for mode=modules. Default: 500
|
|
|
|
*/
|
|
|
|
modulesCount?: number;
|
|
|
|
/**
|
|
|
|
* Collect profile data for progress steps. Default: false
|
|
|
|
*/
|
|
|
|
profile?: true | false | null;
|
|
|
|
}
|