| [9af201e] | 1 | {
|
|---|
| 2 | "definitions": {
|
|---|
| 3 | "HandlerFunction": {
|
|---|
| 4 | "description": "Function that executes for every progress step.",
|
|---|
| 5 | "instanceof": "Function",
|
|---|
| 6 | "tsType": "import('../../lib/ProgressPlugin').HandlerFn"
|
|---|
| 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 | "progressBar": {
|
|---|
| 54 | "description": "Generate progress bar. Default: false.",
|
|---|
| 55 | "anyOf": [
|
|---|
| 56 | {
|
|---|
| 57 | "type": "boolean"
|
|---|
| 58 | },
|
|---|
| 59 | {
|
|---|
| 60 | "type": "object",
|
|---|
| 61 | "additionalProperties": false,
|
|---|
| 62 | "properties": {
|
|---|
| 63 | "color": {
|
|---|
| 64 | "description": "Color used for the filled portion of the bar.",
|
|---|
| 65 | "type": "string"
|
|---|
| 66 | },
|
|---|
| 67 | "name": {
|
|---|
| 68 | "description": "Name shown before the progress bar.",
|
|---|
| 69 | "type": "string"
|
|---|
| 70 | }
|
|---|
| 71 | }
|
|---|
| 72 | }
|
|---|
| 73 | ]
|
|---|
| 74 | }
|
|---|
| 75 | }
|
|---|
| 76 | }
|
|---|
| 77 | },
|
|---|
| 78 | "title": "ProgressPluginArgument",
|
|---|
| 79 | "anyOf": [
|
|---|
| 80 | {
|
|---|
| 81 | "$ref": "#/definitions/ProgressPluginOptions"
|
|---|
| 82 | },
|
|---|
| 83 | {
|
|---|
| 84 | "$ref": "#/definitions/HandlerFunction"
|
|---|
| 85 | }
|
|---|
| 86 | ]
|
|---|
| 87 | }
|
|---|