Merged PR 242: doc updates; package updates

doc updates; package updates
cloudsmithconsulting · Jan 24, 2020 · d1fc31b · d1fc31b
2 parents e122aac + 7798093
commit d1fc31b
Show file tree

Hide file tree

Showing 26 changed files with 777 additions and 142 deletions.
diff --git a/docs/extension/api/classes/_components_configuration_globalstate_.globalstate.md b/docs/extension/api/classes/_components_configuration_globalstate_.globalstate.md
@@ -58,21 +58,21 @@ ___
 
 ###  PowerShellScriptVersion
 
-• **get PowerShellScriptVersion**(): *number*
+• **get PowerShellScriptVersion**(): *string*
 
 Defined in src/components/Configuration/GlobalState.ts:56
 
-**Returns:** *number*
+**Returns:** *string*
 
-• **set PowerShellScriptVersion**(`value`: number): *void*
+• **set PowerShellScriptVersion**(`value`: string): *void*
 
 Defined in src/components/Configuration/GlobalState.ts:59
 
 **Parameters:**
 
 Name | Type |
 ------ | ------ |
-`value` | number |
+`value` | string |
 
 **Returns:** *void*
 

diff --git a/...on/api/classes/_components_webdownloaders_scriptdownloader_.scriptdownloader.md b/...on/api/classes/_components_webdownloaders_scriptdownloader_.scriptdownloader.md
@@ -15,19 +15,17 @@ sidebar_label: "ScriptDownloader"
 ### Methods
 
 * [activate](_components_webdownloaders_scriptdownloader_.scriptdownloader.md#activate)
-* [checkVersion](_components_webdownloaders_scriptdownloader_.scriptdownloader.md#static-checkversion)
-* [downloadScript](_components_webdownloaders_scriptdownloader_.scriptdownloader.md#static-private-downloadscript)
-* [downloadZip](_components_webdownloaders_scriptdownloader_.scriptdownloader.md#static-downloadzip)
 * [installCdsSdk](_components_webdownloaders_scriptdownloader_.scriptdownloader.md#static-installcdssdk)
 * [runScriptCheck](_components_webdownloaders_scriptdownloader_.scriptdownloader.md#static-runscriptcheck)
+* [unzipDownload](_components_webdownloaders_scriptdownloader_.scriptdownloader.md#static-private-unzipdownload)
 
 ## Methods
 
 ###  activate
 
 ▸ **activate**(`context`: ExtensionContext, `config?`: WorkspaceConfiguration): *Promise‹void›*
 
-Defined in src/components/WebDownloaders/ScriptDownloader.ts:19
+Defined in src/components/WebDownloaders/ScriptDownloader.ts:21
 
 **Parameters:**
 
@@ -40,71 +38,36 @@ Name | Type |
 
 ___
 
-### `Static` checkVersion
+### `Static` installCdsSdk
 
-▸ **checkVersion**(`remoteFilePath`: string, `channel`: string): *Promise‹number›*
+▸ **installCdsSdk**(): *Promise‹[TerminalCommand](_components_terminal_secureterminal_.terminalcommand.md)›*
 
-Defined in src/components/WebDownloaders/ScriptDownloader.ts:201
+Defined in src/components/WebDownloaders/ScriptDownloader.ts:144
 
-**Parameters:**
-
-Name | Type |
------- | ------ |
-`remoteFilePath` | string |
-`channel` | string |
-
-**Returns:** *Promise‹number›*
+**Returns:** *Promise‹[TerminalCommand](_components_terminal_secureterminal_.terminalcommand.md)›*
 
 ___
 
-### `Static` `Private` downloadScript
-
-▸ **downloadScript**(`remoteFilePath`: string, `localFilePath`: string): *Promise‹string›*
-
-Defined in src/components/WebDownloaders/ScriptDownloader.ts:159
+### `Static` runScriptCheck
 
-**Parameters:**
+▸ **runScriptCheck**(): *Promise‹void›*
 
-Name | Type |
------- | ------ |
-`remoteFilePath` | string |
-`localFilePath` | string |
+Defined in src/components/WebDownloaders/ScriptDownloader.ts:26
 
-**Returns:** *Promise‹string›*
+**Returns:** *Promise‹void›*
 
 ___
 
-### `Static` downloadZip
+### `Static` `Private` unzipDownload
 
-▸ **downloadZip**(`remoteFilePath`: string, `localFilePath`: string): *Promise‹string›*
+▸ **unzipDownload**(`options`: any): *Promise‹void›*
 
-Defined in src/components/WebDownloaders/ScriptDownloader.ts:180
+Defined in src/components/WebDownloaders/ScriptDownloader.ts:160
 
 **Parameters:**
 
 Name | Type |
 ------ | ------ |
-`remoteFilePath` | string |
-`localFilePath` | string |
-
-**Returns:** *Promise‹string›*
-
-___
-
-### `Static` installCdsSdk
-
-▸ **installCdsSdk**(): *Promise‹[TerminalCommand](_components_terminal_secureterminal_.terminalcommand.md)›*
-
-Defined in src/components/WebDownloaders/ScriptDownloader.ts:217
-
-**Returns:** *Promise‹[TerminalCommand](_components_terminal_secureterminal_.terminalcommand.md)›*
-
-___
-
-### `Static` runScriptCheck
-
-▸ **runScriptCheck**(): *Promise‹void›*
-
-Defined in src/components/WebDownloaders/ScriptDownloader.ts:24
+`options` | any |
 
 **Returns:** *Promise‹void›*
diff --git a/docs/extension/api/classes/_components_webdownloaders_types_.extensionicontheme.md b/docs/extension/api/classes/_components_webdownloaders_types_.extensionicontheme.md
@@ -133,7 +133,7 @@ ___
 
 ▸ **getIcons**(`mappings`: [Dictionary](_core_types_dictionary_.dictionary.md)‹[ExtensionIcon](../modules/_components_webdownloaders_types_.md#extensionicon), string›, `lightColor?`: string, `darkColor?`: string): *[IconifyIcon](_components_webdownloaders_types_.iconifyicon.md)[]*
 
-Defined in src/components/WebDownloaders/Types.ts:126
+Defined in src/components/WebDownloaders/Types.ts:123
 
 **Parameters:**
 

diff --git a/.../extension/api/classes/_components_webdownloaders_types_.extensioniconthemes.md b/.../extension/api/classes/_components_webdownloaders_types_.extensioniconthemes.md
@@ -33,15 +33,15 @@ sidebar_label: "ExtensionIconThemes"
 
 ▪ **_themes**: *[ExtensionIconTheme](_components_webdownloaders_types_.extensionicontheme.md)[]* = [ ExtensionIconThemes.default ]
 
-Defined in src/components/WebDownloaders/Types.ts:156
+Defined in src/components/WebDownloaders/Types.ts:153
 
 ## Accessors
 
 ### `Static` default
 
 • **get default**(): *[ExtensionIconTheme](_components_webdownloaders_types_.extensionicontheme.md)*
 
-Defined in src/components/WebDownloaders/Types.ts:150
+Defined in src/components/WebDownloaders/Types.ts:147
 
 **Returns:** *[ExtensionIconTheme](_components_webdownloaders_types_.extensionicontheme.md)*
 
@@ -51,7 +51,7 @@ ___
 
 • **get selected**(): *[ExtensionIconTheme](_components_webdownloaders_types_.extensionicontheme.md)*
 
-Defined in src/components/WebDownloaders/Types.ts:158
+Defined in src/components/WebDownloaders/Types.ts:155
 
 **Returns:** *[ExtensionIconTheme](_components_webdownloaders_types_.extensionicontheme.md)*
 
@@ -61,7 +61,7 @@ Defined in src/components/WebDownloaders/Types.ts:158
 
 ▸ **get**(`name`: string): *[ExtensionIconTheme](_components_webdownloaders_types_.extensionicontheme.md)‹›*
 
-Defined in src/components/WebDownloaders/Types.ts:168
+Defined in src/components/WebDownloaders/Types.ts:165
 
 **Parameters:**
 
@@ -77,7 +77,7 @@ ___
 
 ▸ **register**(`theme`: [ExtensionIconTheme](_components_webdownloaders_types_.extensionicontheme.md)): *void*
 
-Defined in src/components/WebDownloaders/Types.ts:172
+Defined in src/components/WebDownloaders/Types.ts:169
 
 **Parameters:**
 
@@ -93,7 +93,7 @@ ___
 
 ▸ **unregister**(`theme`: [ExtensionIconTheme](_components_webdownloaders_types_.extensionicontheme.md)): *void*
 
-Defined in src/components/WebDownloaders/Types.ts:178
+Defined in src/components/WebDownloaders/Types.ts:175
 
 **Parameters:**
 

diff --git a/docs/extension/api/classes/_components_webdownloaders_types_.iconifyicon.md b/docs/extension/api/classes/_components_webdownloaders_types_.iconifyicon.md
@@ -45,7 +45,7 @@ sidebar_label: "IconifyIcon"
 
 \+ **new IconifyIcon**(`name`: string, `color?`: string, `annotation?`: string, `height`: number, `width`: number, `format`: [ScriptedIconFormat](../enums/_components_webdownloaders_types_.scriptediconformat.md), `extensionIcon?`: [ExtensionIcon](../modules/_components_webdownloaders_types_.md#extensionicon)): *[IconifyIcon](_components_webdownloaders_types_.iconifyicon.md)*
 
-Defined in src/components/WebDownloaders/Types.ts:213
+Defined in src/components/WebDownloaders/Types.ts:210
 
 **Parameters:**
 
@@ -67,69 +67,69 @@ Name | Type | Default |
 
 • **_color**: *string*
 
-Defined in src/components/WebDownloaders/Types.ts:206
+Defined in src/components/WebDownloaders/Types.ts:203
 
 ___
 
 ###  annotation
 
 • **annotation**: *string*
 
-Defined in src/components/WebDownloaders/Types.ts:212
+Defined in src/components/WebDownloaders/Types.ts:209
 
 ___
 
 ###  extensionIcon
 
 • **extensionIcon**: *[ExtensionIcon](../modules/_components_webdownloaders_types_.md#extensionicon)*
 
-Defined in src/components/WebDownloaders/Types.ts:213
+Defined in src/components/WebDownloaders/Types.ts:210
 
 ___
 
 ###  format
 
 • **format**: *[ScriptedIconFormat](../enums/_components_webdownloaders_types_.scriptediconformat.md)*
 
-Defined in src/components/WebDownloaders/Types.ts:211
+Defined in src/components/WebDownloaders/Types.ts:208
 
 ___
 
 ### `Optional` height
 
 • **height**? : *number*
 
-Defined in src/components/WebDownloaders/Types.ts:208
+Defined in src/components/WebDownloaders/Types.ts:205
 
 ___
 
 ###  name
 
 • **name**: *string*
 
-Defined in src/components/WebDownloaders/Types.ts:210
+Defined in src/components/WebDownloaders/Types.ts:207
 
 ___
 
 ### `Optional` width
 
 • **width**? : *number*
 
-Defined in src/components/WebDownloaders/Types.ts:209
+Defined in src/components/WebDownloaders/Types.ts:206
 
 ## Accessors
 
 ###  color
 
 • **get color**(): *string*
 
-Defined in src/components/WebDownloaders/Types.ts:225
+Defined in src/components/WebDownloaders/Types.ts:222
 
 **Returns:** *string*
 
 • **set color**(`value`: string): *void*
 
-Defined in src/components/WebDownloaders/Types.ts:226
+Defined in src/components/WebDownloaders/Types.ts:223
 
 **Parameters:**
 
@@ -145,7 +145,7 @@ ___
 
 • **get mappedOutputFile**(): *string*
 
-Defined in src/components/WebDownloaders/Types.ts:236
+Defined in src/components/WebDownloaders/Types.ts:233
 
 **Returns:** *string*
 
@@ -155,7 +155,7 @@ ___
 
 • **get mimeType**(): *string*
 
-Defined in src/components/WebDownloaders/Types.ts:244
+Defined in src/components/WebDownloaders/Types.ts:241
 
 **Returns:** *string*
 
@@ -165,7 +165,7 @@ ___
 
 • **get outputfile**(): *string*
 
-Defined in src/components/WebDownloaders/Types.ts:240
+Defined in src/components/WebDownloaders/Types.ts:237
 
 **Returns:** *string*
 
@@ -175,7 +175,7 @@ ___
 
 • **get url**(): *string*
 
-Defined in src/components/WebDownloaders/Types.ts:232
+Defined in src/components/WebDownloaders/Types.ts:229
 
 **Returns:** *string*
 
@@ -185,7 +185,7 @@ Defined in src/components/WebDownloaders/Types.ts:232
 
 ▸ **isColorCode**(`value`: string): *boolean*
 
-Defined in src/components/WebDownloaders/Types.ts:255
+Defined in src/components/WebDownloaders/Types.ts:252
 
 **Parameters:**
 
@@ -201,6 +201,6 @@ ___
 
 ▸ **toQueryObject**(): *any*
 
-Defined in src/components/WebDownloaders/Types.ts:259
+Defined in src/components/WebDownloaders/Types.ts:256
 
 **Returns:** *any*
diff --git a/docs/extension/api/classes/_components_webdownloaders_types_.iconresolver.md b/docs/extension/api/classes/_components_webdownloaders_types_.iconresolver.md
@@ -28,7 +28,7 @@ sidebar_label: "IconResolver"
 
 \+ **new IconResolver**(`lightPath`: string, `darkPath`: string): *[IconResolver](_components_webdownloaders_types_.iconresolver.md)*
 
-Defined in src/components/WebDownloaders/Types.ts:192
+Defined in src/components/WebDownloaders/Types.ts:189
 
 **Parameters:**
 
@@ -45,15 +45,15 @@ Name | Type |
 
 • **darkPath**: *string*
 
-Defined in src/components/WebDownloaders/Types.ts:196
+Defined in src/components/WebDownloaders/Types.ts:193
 
 ___
 
 ###  iconPath
 
 • **iconPath**: *object* = null
 
-Defined in src/components/WebDownloaders/Types.ts:192
+Defined in src/components/WebDownloaders/Types.ts:189
 
 #### Type declaration:
 
@@ -67,4 +67,4 @@ ___
 
 • **lightPath**: *string*
 
-Defined in src/components/WebDownloaders/Types.ts:195
+Defined in src/components/WebDownloaders/Types.ts:192