ProgressPlugin.json 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. {
  2. "definitions": {
  3. "HandlerFunction": {
  4. "description": "Function that executes for every progress step.",
  5. "instanceof": "Function",
  6. "tsType": "((percentage: number, msg: string, ...args: string[]) => void)"
  7. },
  8. "ProgressPluginOptions": {
  9. "description": "Options object for the ProgressPlugin.",
  10. "type": "object",
  11. "additionalProperties": false,
  12. "properties": {
  13. "activeModules": {
  14. "description": "Show active modules count and one active module in progress message.",
  15. "type": "boolean"
  16. },
  17. "dependencies": {
  18. "description": "Show dependencies count in progress message.",
  19. "type": "boolean"
  20. },
  21. "dependenciesCount": {
  22. "description": "Minimum dependencies count to start with. For better progress calculation. Default: 10000.",
  23. "type": "number"
  24. },
  25. "entries": {
  26. "description": "Show entries count in progress message.",
  27. "type": "boolean"
  28. },
  29. "handler": {
  30. "description": "Function that executes for every progress step.",
  31. "oneOf": [
  32. {
  33. "$ref": "#/definitions/HandlerFunction"
  34. }
  35. ]
  36. },
  37. "modules": {
  38. "description": "Show modules count in progress message.",
  39. "type": "boolean"
  40. },
  41. "modulesCount": {
  42. "description": "Minimum modules count to start with. For better progress calculation. Default: 5000.",
  43. "type": "number"
  44. },
  45. "percentBy": {
  46. "description": "Collect percent algorithm. By default it calculates by a median from modules, entries and dependencies percent.",
  47. "enum": ["entries", "modules", "dependencies", null]
  48. },
  49. "profile": {
  50. "description": "Collect profile data for progress steps. Default: false.",
  51. "enum": [true, false, null]
  52. }
  53. }
  54. }
  55. },
  56. "title": "ProgressPluginArgument",
  57. "anyOf": [
  58. {
  59. "$ref": "#/definitions/ProgressPluginOptions"
  60. },
  61. {
  62. "$ref": "#/definitions/HandlerFunction"
  63. }
  64. ]
  65. }