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