ProgressPlugin.d.ts 951 B

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. /**
  2. * This file was automatically generated.
  3. * DO NOT MODIFY BY HAND.
  4. * Run `yarn special-lint-fix` to update
  5. */
  6. export type ProgressPluginArgument = ProgressPluginOptions | HandlerFunction;
  7. /**
  8. * Function that executes for every progress step
  9. */
  10. export type HandlerFunction = (
  11. percentage: number,
  12. msg: string,
  13. ...args: string[]
  14. ) => void;
  15. export interface ProgressPluginOptions {
  16. /**
  17. * Show active modules count and one active module in progress message
  18. */
  19. activeModules?: boolean;
  20. /**
  21. * Show entries count in progress message
  22. */
  23. entries?: boolean;
  24. /**
  25. * Function that executes for every progress step
  26. */
  27. handler?: HandlerFunction;
  28. /**
  29. * Show modules count in progress message
  30. */
  31. modules?: boolean;
  32. /**
  33. * Minimum modules count to start with. Only for mode=modules. Default: 500
  34. */
  35. modulesCount?: number;
  36. /**
  37. * Collect profile data for progress steps. Default: false
  38. */
  39. profile?: true | false | null;
  40. }