Merge pull request #309 from microsoft/automated/update-api-docs

docs: update API documentation

Author: iclanton

websites/api.rushstack.io/data/api_nav.json

@@ -4009,6 +4009,11 @@
               "label": "loadFromFile",
               "id": "pages/rush-lib.commonversionsconfiguration.loadfromfile"
             },
+            {
+              "type": "doc",
+              "label": "loadFromFileAsync",
+              "id": "pages/rush-lib.commonversionsconfiguration.loadfromfileasync"
+            },
             {
               "type": "doc",
               "label": "preferredVersions",
@@ -4018,6 +4023,11 @@
               "type": "doc",
               "label": "save",
               "id": "pages/rush-lib.commonversionsconfiguration.save"
+            },
+            {
+              "type": "doc",
+              "label": "saveAsync",
+              "id": "pages/rush-lib.commonversionsconfiguration.saveasync"
             }
           ]
         },
@@ -4889,9 +4899,25 @@
           ]
         },
         {
-          "type": "doc",
+          "type": "category",
           "label": "IGlobalCommand",
-          "id": "pages/rush-lib.iglobalcommand"
+          "items": [
+            {
+              "type": "doc",
+              "label": "(members)",
+              "id": "pages/rush-lib.iglobalcommand"
+            },
+            {
+              "type": "doc",
+              "label": "getCustomParametersByLongName",
+              "id": "pages/rush-lib.iglobalcommand.getcustomparametersbylongname"
+            },
+            {
+              "type": "doc",
+              "label": "setHandled",
+              "id": "pages/rush-lib.iglobalcommand.sethandled"
+            }
+          ]
         },
         {
           "type": "category",
@@ -6152,6 +6178,11 @@
               "label": "load",
               "id": "pages/rush-lib.packagejsoneditor.load"
             },
+            {
+              "type": "doc",
+              "label": "loadAsync",
+              "id": "pages/rush-lib.packagejsoneditor.loadasync"
+            },
             {
               "type": "doc",
               "label": "name",
@@ -6172,6 +6203,11 @@
               "label": "saveIfModified",
               "id": "pages/rush-lib.packagejsoneditor.saveifmodified"
             },
+            {
+              "type": "doc",
+              "label": "saveIfModifiedAsync",
+              "id": "pages/rush-lib.packagejsoneditor.saveifmodifiedasync"
+            },
             {
               "type": "doc",
               "label": "saveToObject",
@@ -7243,6 +7279,11 @@
               "label": "globalCommandKind",
               "id": "pages/rush-lib.rushconstants.globalcommandkind"
             },
+            {
+              "type": "doc",
+              "label": "globalPluginCommandKind",
+              "id": "pages/rush-lib.rushconstants.globalplugincommandkind"
+            },
             {
               "type": "doc",
               "label": "hashDelimiter",
@@ -7850,11 +7891,21 @@
               "label": "setDependenciesBeforeCommit",
               "id": "pages/rush-lib.versionpolicy.setdependenciesbeforecommit"
             },
+            {
+              "type": "doc",
+              "label": "setDependenciesBeforeCommitAsync",
+              "id": "pages/rush-lib.versionpolicy.setdependenciesbeforecommitasync"
+            },
             {
               "type": "doc",
               "label": "setDependenciesBeforePublish",
               "id": "pages/rush-lib.versionpolicy.setdependenciesbeforepublish"
             },
+            {
+              "type": "doc",
+              "label": "setDependenciesBeforePublishAsync",
+              "id": "pages/rush-lib.versionpolicy.setdependenciesbeforepublishasync"
+            },
             {
               "type": "doc",
               "label": "validate",

websites/api.rushstack.io/docs/pages/rush-lib.commonversionsconfiguration.loadfromfile.md

@@ -10,7 +10,10 @@ pagination_next: null
 
 ## CommonVersionsConfiguration.loadFromFile() method
 
-Loads the common-versions.json data from the specified file path. If the file has not been created yet, then an empty object is returned.
+> Warning: This API is now obsolete.
+> 
+> Use [CommonVersionsConfiguration.loadFromFileAsync()](./rush-lib.commonversionsconfiguration.loadfromfileasync.md) method instead.
+> 
 
 **Signature:**
 

websites/api.rushstack.io/docs/pages/rush-lib.commonversionsconfiguration.loadfromfileasync.md

@@ -0,0 +1,74 @@
+---
+hide_title: true
+custom_edit_url: null
+pagination_prev: null
+pagination_next: null
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/rush-lib](./rush-lib.md) &gt; [CommonVersionsConfiguration](./rush-lib.commonversionsconfiguration.md) &gt; [loadFromFileAsync](./rush-lib.commonversionsconfiguration.loadfromfileasync.md)
+
+## CommonVersionsConfiguration.loadFromFileAsync() method
+
+Loads the common-versions.json data from the specified file path. If the file has not been created yet, then an empty object is returned.
+
+**Signature:**
+
+```typescript
+static loadFromFileAsync(jsonFilePath: string, rushConfiguration?: RushConfiguration): Promise<CommonVersionsConfiguration>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+jsonFilePath
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+rushConfiguration
+
+
+</td><td>
+
+[RushConfiguration](./rush-lib.rushconfiguration.md)
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;[CommonVersionsConfiguration](./rush-lib.commonversionsconfiguration.md)<></>&gt;
+

websites/api.rushstack.io/docs/pages/rush-lib.commonversionsconfiguration.md

@@ -206,6 +206,20 @@ Get a sha1 hash of the preferred versions.
 `static`
 
 
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[loadFromFileAsync(jsonFilePath, rushConfiguration)](./rush-lib.commonversionsconfiguration.loadfromfileasync.md)
+
+
+</td><td>
+
+`static`
+
+
 </td><td>
 
 Loads the common-versions.json data from the specified file path. If the file has not been created yet, then an empty object is returned.
@@ -220,6 +234,18 @@ Loads the common-versions.json data from the specified file path. If the file ha
 </td><td>
 
 
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[saveAsync()](./rush-lib.commonversionsconfiguration.saveasync.md)
+
+
+</td><td>
+
+
 </td><td>
 
 Writes the "common-versions.json" file to disk, using the filename that was passed to loadFromFile().

websites/api.rushstack.io/docs/pages/rush-lib.commonversionsconfiguration.save.md

@@ -10,7 +10,10 @@ pagination_next: null
 
 ## CommonVersionsConfiguration.save() method
 
-Writes the "common-versions.json" file to disk, using the filename that was passed to loadFromFile().
+> Warning: This API is now obsolete.
+> 
+> Use [CommonVersionsConfiguration.saveAsync()](./rush-lib.commonversionsconfiguration.saveasync.md) method instead.
+> 
 
 **Signature:**
 

websites/api.rushstack.io/docs/pages/rush-lib.commonversionsconfiguration.saveasync.md

@@ -0,0 +1,23 @@
+---
+hide_title: true
+custom_edit_url: null
+pagination_prev: null
+pagination_next: null
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/rush-lib](./rush-lib.md) &gt; [CommonVersionsConfiguration](./rush-lib.commonversionsconfiguration.md) &gt; [saveAsync](./rush-lib.commonversionsconfiguration.saveasync.md)
+
+## CommonVersionsConfiguration.saveAsync() method
+
+Writes the "common-versions.json" file to disk, using the filename that was passed to loadFromFile().
+
+**Signature:**
+
+```typescript
+saveAsync(): Promise<boolean>;
+```
+**Returns:**
+
+Promise&lt;boolean&gt;
+

websites/api.rushstack.io/docs/pages/rush-lib.iglobalcommand.getcustomparametersbylongname.md

@@ -0,0 +1,61 @@
+---
+hide_title: true
+custom_edit_url: null
+pagination_prev: null
+pagination_next: null
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@microsoft/rush-lib](./rush-lib.md) &gt; [IGlobalCommand](./rush-lib.iglobalcommand.md) &gt; [getCustomParametersByLongName](./rush-lib.iglobalcommand.getcustomparametersbylongname.md)
+
+## IGlobalCommand.getCustomParametersByLongName() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Get a parameter by its long name (e.g. "--output-path") that was defined in command-line.json for this command. If the parameter was not defined or not provided on the command line, this will throw.
+
+**Signature:**
+
+```typescript
+getCustomParametersByLongName<TParameter extends CommandLineParameter>(longName: string): TParameter;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+longName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+TParameter
+

websites/api.rushstack.io/docs/pages/rush-lib.iglobalcommand.md

@@ -22,3 +22,40 @@ export interface IGlobalCommand extends IRushCommand
 ```
 **Extends:** [IRushCommand](./rush-lib.irushcommand.md)
 
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[getCustomParametersByLongName(longName)](./rush-lib.iglobalcommand.getcustomparametersbylongname.md)
+
+
+</td><td>
+
+**_(BETA)_** Get a parameter by its long name (e.g. "--output-path") that was defined in command-line.json for this command. If the parameter was not defined or not provided on the command line, this will throw.
+
+
+</td></tr>
+<tr><td>
+
+[setHandled()](./rush-lib.iglobalcommand.sethandled.md)
+
+
+</td><td>
+
+**_(BETA)_** Call this from a plugin hook to indicate that the command has been fully handled by the plugin. When set, the default shell command execution will be skipped.
+
+
+</td></tr>
+</tbody></table>
+