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

docs: update API documentation

Author: iclanton

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

@@ -10278,6 +10278,32 @@
             }
           ]
         },
+        {
+          "type": "category",
+          "label": "ILookupByPathJson",
+          "items": [
+            {
+              "type": "doc",
+              "label": "(members)",
+              "id": "pages/lookup-by-path.ilookupbypathjson"
+            },
+            {
+              "type": "doc",
+              "label": "delimiter",
+              "id": "pages/lookup-by-path.ilookupbypathjson.delimiter"
+            },
+            {
+              "type": "doc",
+              "label": "tree",
+              "id": "pages/lookup-by-path.ilookupbypathjson.tree"
+            },
+            {
+              "type": "doc",
+              "label": "values",
+              "id": "pages/lookup-by-path.ilookupbypathjson.values"
+            }
+          ]
+        },
         {
           "type": "category",
           "label": "IPrefixMatch",
@@ -10357,6 +10383,11 @@
               "type": "doc",
               "label": "has",
               "id": "pages/lookup-by-path.ireadonlylookupbypath.has"
+            },
+            {
+              "type": "doc",
+              "label": "toJson",
+              "id": "pages/lookup-by-path.ireadonlylookupbypath.tojson"
             }
           ]
         },
@@ -10381,6 +10412,27 @@
             }
           ]
         },
+        {
+          "type": "category",
+          "label": "ISerializedPathTrieNode",
+          "items": [
+            {
+              "type": "doc",
+              "label": "(members)",
+              "id": "pages/lookup-by-path.iserializedpathtrienode"
+            },
+            {
+              "type": "doc",
+              "label": "children",
+              "id": "pages/lookup-by-path.iserializedpathtrienode.children"
+            },
+            {
+              "type": "doc",
+              "label": "valueIndex",
+              "id": "pages/lookup-by-path.iserializedpathtrienode.valueindex"
+            }
+          ]
+        },
         {
           "type": "category",
           "label": "LookupByPath",
@@ -10440,6 +10492,11 @@
               "label": "findLongestPrefixMatch",
               "id": "pages/lookup-by-path.lookupbypath.findlongestprefixmatch"
             },
+            {
+              "type": "doc",
+              "label": "fromJson",
+              "id": "pages/lookup-by-path.lookupbypath.fromjson"
+            },
             {
               "type": "doc",
               "label": "get",
@@ -10480,6 +10537,11 @@
               "label": "size",
               "id": "pages/lookup-by-path.lookupbypath.size"
             },
+            {
+              "type": "doc",
+              "label": "toJson",
+              "id": "pages/lookup-by-path.lookupbypath.tojson"
+            },
             {
               "type": "doc",
               "label": "tree",
@@ -11377,6 +11439,11 @@
               "label": "createHardLinkAsync",
               "id": "pages/node-core-library.filesystem.createhardlinkasync"
             },
+            {
+              "type": "doc",
+              "label": "createReadStream",
+              "id": "pages/node-core-library.filesystem.createreadstream"
+            },
             {
               "type": "doc",
               "label": "createSymbolicLinkFile",
@@ -11407,6 +11474,16 @@
               "label": "createSymbolicLinkJunctionAsync",
               "id": "pages/node-core-library.filesystem.createsymboliclinkjunctionasync"
             },
+            {
+              "type": "doc",
+              "label": "createWriteStream",
+              "id": "pages/node-core-library.filesystem.createwritestream"
+            },
+            {
+              "type": "doc",
+              "label": "createWriteStreamAsync",
+              "id": "pages/node-core-library.filesystem.createwritestreamasync"
+            },
             {
               "type": "doc",
               "label": "deleteFile",
@@ -11644,11 +11721,21 @@
           "label": "FileSystemCopyFilesFilter",
           "id": "pages/node-core-library.filesystemcopyfilesfilter"
         },
+        {
+          "type": "doc",
+          "label": "FileSystemReadStream",
+          "id": "pages/node-core-library.filesystemreadstream"
+        },
         {
           "type": "doc",
           "label": "FileSystemStats",
           "id": "pages/node-core-library.filesystemstats"
         },
+        {
+          "type": "doc",
+          "label": "FileSystemWriteStream",
+          "id": "pages/node-core-library.filesystemwritestream"
+        },
         {
           "type": "category",
           "label": "FileWriter",
@@ -11987,6 +12074,11 @@
             }
           ]
         },
+        {
+          "type": "doc",
+          "label": "IFileSystemCreateWriteStreamOptions",
+          "id": "pages/node-core-library.ifilesystemcreatewritestreamoptions"
+        },
         {
           "type": "category",
           "label": "IFileSystemDeleteFileOptions",
@@ -12017,11 +12109,6 @@
               "label": "destinationPath",
               "id": "pages/node-core-library.ifilesystemmoveoptions.destinationpath"
             },
-            {
-              "type": "doc",
-              "label": "ensureFolderExists",
-              "id": "pages/node-core-library.ifilesystemmoveoptions.ensurefolderexists"
-            },
             {
               "type": "doc",
               "label": "overwrite",
@@ -12093,20 +12180,9 @@
           ]
         },
         {
-          "type": "category",
+          "type": "doc",
           "label": "IFileSystemWriteBinaryFileOptions",
-          "items": [
-            {
-              "type": "doc",
-              "label": "(members)",
-              "id": "pages/node-core-library.ifilesystemwritebinaryfileoptions"
-            },
-            {
-              "type": "doc",
-              "label": "ensureFolderExists",
-              "id": "pages/node-core-library.ifilesystemwritebinaryfileoptions.ensurefolderexists"
-            }
-          ]
+          "id": "pages/node-core-library.ifilesystemwritebinaryfileoptions"
         },
         {
           "type": "category",
@@ -12129,6 +12205,22 @@
             }
           ]
         },
+        {
+          "type": "category",
+          "label": "IFileSystemWriteFileOptionsBase",
+          "items": [
+            {
+              "type": "doc",
+              "label": "(members)",
+              "id": "pages/node-core-library.ifilesystemwritefileoptionsbase"
+            },
+            {
+              "type": "doc",
+              "label": "ensureFolderExists",
+              "id": "pages/node-core-library.ifilesystemwritefileoptionsbase.ensurefolderexists"
+            }
+          ]
+        },
         {
           "type": "category",
           "label": "IFileWriterFlags",

websites/api.rushstack.io/docs/pages/api-extractor.iconfigapireport.includeforgottenexports.md

@@ -18,6 +18,10 @@ Whether "forgotten exports" should be included in the API report file.
 includeForgottenExports?: boolean;
 ```
 
+## Default Value
+
+`false`
+
 ## Remarks
 
 Forgotten exports are declarations flagged with `ae-forgotten-export` warnings. See https://api-extractor.com/pages/messages/ae-forgotten-export/ to learn more.

websites/api.rushstack.io/docs/pages/api-extractor.iconfigapireport.reportfilename.md

@@ -18,6 +18,10 @@ The base filename for the API report files, to be combined with [IConfigApiRepor
 reportFileName?: string;
 ```
 
+## Default Value
+
+`<unscopedPackageName>`
+
 ## Remarks
 
 The `reportFileName` should not include any path separators such as `\` or `/`<></>. The `reportFileName` should not include a file extension, since API Extractor will automatically append an appropriate file extension such as `.api.md`<></>. If the [IConfigApiReport.reportVariants](./api-extractor.iconfigapireport.reportvariants.md) setting is used, then the file extension includes the variant name, for example `my-report.public.api.md` or `my-report.beta.api.md`<></>. The `complete` variant always uses the simple extension `my-report.api.md`<></>.

websites/api.rushstack.io/docs/pages/api-extractor.iconfigapireport.reportvariants.md

@@ -18,6 +18,10 @@ The set of report variants to generate.
 reportVariants?: ApiReportVariant[];
 ```
 
+## Default Value
+
+`[ "complete" ]`
+
 ## Remarks
 
 To support different approval requirements for different API levels, multiple "variants" of the API report can be generated. The `reportVariants` setting specifies a list of variants to be generated. If omitted, by default only the `complete` variant will be generated, which includes all `@internal`<></>, `@alpha`<></>, `@beta`<></>, and `@public` items. Other possible variants are `alpha` (`@alpha` + `@beta` + `@public`<></>), `beta` (`@beta` + `@public`<></>), and `public` (`@public only`<></>).

websites/api.rushstack.io/docs/pages/api-extractor.iconfigapireport.tagstoreport.md

@@ -18,6 +18,10 @@ Specifies a list of [TSDoc](https://tsdoc.org/) tags that should be reported in
 tagsToReport?: Readonly<Record<`@${string}`, boolean>>;
 ```
 
+## Default Value
+
+`@sealed`<></>, `@virtual`<></>, `@override`<></>, `@eventProperty`<></>, and `@deprecated`
+
 ## Remarks
 
 Tag names must begin with `@`<></>.

websites/api.rushstack.io/docs/pages/api-extractor.iconfigdocmodel.includeforgottenexports.md

@@ -18,6 +18,10 @@ Whether "forgotten exports" should be included in the doc model file.
 includeForgottenExports?: boolean;
 ```
 
+## Default Value
+
+`false`
+
 ## Remarks
 
 Forgotten exports are declarations flagged with `ae-forgotten-export` warnings. See https://api-extractor.com/pages/messages/ae-forgotten-export/ to learn more.

websites/api.rushstack.io/docs/pages/api-extractor.iconfigdocmodel.releasetagstotrim.md

@@ -17,3 +17,8 @@ Specifies a list of release tags that will be trimmed from the doc model.
 ```typescript
 releaseTagsToTrim?: ReleaseTagForTrim[];
 ```
+
+## Default Value
+
+`["@internal"]`
+

websites/api.rushstack.io/docs/pages/api-extractor.iconfigfile.enummemberorder.md

@@ -18,6 +18,10 @@ Specifies how API Extractor sorts members of an enum when generating the .api.js
 enumMemberOrder?: EnumMemberOrder;
 ```
 
+## Default Value
+
+`by-name`
+
 ## Remarks
 
 By default, the output files will be sorted alphabetically, which is "by-name". To keep the ordering in the source code, specify "preserve".

websites/api.rushstack.io/docs/pages/heft.igloboptions.absolute.md

@@ -17,3 +17,8 @@ Whether or not the returned file paths should be absolute.
 ```typescript
 absolute?: boolean;
 ```
+
+## Default Value
+
+false
+

websites/api.rushstack.io/docs/pages/heft.igloboptions.dot.md

@@ -17,3 +17,8 @@ Whether or not to include dot files when globbing.
 ```typescript
 dot?: boolean;
 ```
+
+## Default Value
+
+false
+