update docs with better description

electron-userland · Sep 13, 2024 · 99128d6 · 99128d6
1 parent f8daa77
commit 99128d6
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 5 deletions.
diff --git a/docs/api/electron-builder.md b/docs/api/electron-builder.md
@@ -192,7 +192,7 @@ Developer API only. See [Configuration](../configuration/configuration.md) for u
 <li><a href="#module_app-builder-lib.Packager+dispatchArtifactCreated"><code>.dispatchArtifactCreated(event)</code></a></li>
 <li><a href="#module_app-builder-lib.Packager+disposeOnBuildFinish"><code>.disposeOnBuildFinish(disposer)</code></a></li>
 <li><a href="#module_app-builder-lib.Packager+installAppDependencies"><code>.installAppDependencies(platform, arch)</code></a> ⇒ <code>Promise&lt;any&gt;</code></li>
-<li><a href="#module_app-builder-lib.Packager+getNodeDependencyInfo"><code>.getNodeDependencyInfo(platform)</code></a> ⇒ <code>Lazy&lt;Array&lt;module:app-builder-lib/out/util/packageDependencies.NodeModuleDirInfo | module:app-builder-lib/out/util/packageDependencies.NodeModuleInfo&gt;&gt;</code></li>
+<li><a href="#module_app-builder-lib.Packager+getNodeDependencyInfo"><code>.getNodeDependencyInfo(platform, flatten)</code></a> ⇒ <code>Lazy&lt;Array&lt;module:app-builder-lib/out/util/packageDependencies.NodeModuleInfo | module:app-builder-lib/out/util/packageDependencies.NodeModuleDirInfo&gt;&gt;</code></li>
 <li><a href="#module_app-builder-lib.Packager+validateConfig"><code>.validateConfig()</code></a> ⇒ <code>Promise&lt;void&gt;</code></li>
 </ul>
 </li>
@@ -1531,7 +1531,7 @@ return path.join(target.outDir, <code>__${target.name}-${getArtifactArchName(arc
 <li><a href="#module_app-builder-lib.Packager+dispatchArtifactCreated"><code>.dispatchArtifactCreated(event)</code></a></li>
 <li><a href="#module_app-builder-lib.Packager+disposeOnBuildFinish"><code>.disposeOnBuildFinish(disposer)</code></a></li>
 <li><a href="#module_app-builder-lib.Packager+installAppDependencies"><code>.installAppDependencies(platform, arch)</code></a> ⇒ <code>Promise&lt;any&gt;</code></li>
-<li><a href="#module_app-builder-lib.Packager+getNodeDependencyInfo"><code>.getNodeDependencyInfo(platform)</code></a> ⇒ <code>Lazy&lt;Array&lt;module:app-builder-lib/out/util/packageDependencies.NodeModuleDirInfo | module:app-builder-lib/out/util/packageDependencies.NodeModuleInfo&gt;&gt;</code></li>
+<li><a href="#module_app-builder-lib.Packager+getNodeDependencyInfo"><code>.getNodeDependencyInfo(platform, flatten)</code></a> ⇒ <code>Lazy&lt;Array&lt;module:app-builder-lib/out/util/packageDependencies.NodeModuleInfo | module:app-builder-lib/out/util/packageDependencies.NodeModuleDirInfo&gt;&gt;</code></li>
 <li><a href="#module_app-builder-lib.Packager+validateConfig"><code>.validateConfig()</code></a> ⇒ <code>Promise&lt;void&gt;</code></li>
 </ul>
 </li>
@@ -1722,7 +1722,7 @@ return path.join(target.outDir, <code>__${target.name}-${getArtifactArchName(arc
 </tbody>
 </table>
 <p><a name="module_app-builder-lib.Packager+getNodeDependencyInfo"></a></p>
-<h3 id="packager.getnodedependencyinfo(platform)-%E2%87%92-lazy%3Carray%3Cmodule%3Aapp-builder-lib%2Fout%2Futil%2Fpackagedependencies.nodemoduledirinfo-%7C-module%3Aapp-builder-lib%2Fout%2Futil%2Fpackagedependencies.nodemoduleinfo%3E%3E"><code>packager.getNodeDependencyInfo(platform)</code> ⇒ <code>Lazy&lt;Array&lt;module:app-builder-lib/out/util/packageDependencies.NodeModuleDirInfo | module:app-builder-lib/out/util/packageDependencies.NodeModuleInfo&gt;&gt;</code></h3>
+<h3 id="packager.getnodedependencyinfo(platform%2C-flatten)-%E2%87%92-lazy%3Carray%3Cmodule%3Aapp-builder-lib%2Fout%2Futil%2Fpackagedependencies.nodemoduleinfo-%7C-module%3Aapp-builder-lib%2Fout%2Futil%2Fpackagedependencies.nodemoduledirinfo%3E%3E"><code>packager.getNodeDependencyInfo(platform, flatten)</code> ⇒ <code>Lazy&lt;Array&lt;module:app-builder-lib/out/util/packageDependencies.NodeModuleInfo | module:app-builder-lib/out/util/packageDependencies.NodeModuleDirInfo&gt;&gt;</code></h3>
 <table>
 <thead>
 <tr>
@@ -1735,6 +1735,10 @@ return path.join(target.outDir, <code>__${target.name}-${getArtifactArchName(arc
 <td>platform</td>
 <td><code><a href="#Platform">Platform</a></code> | <code>“undefined”</code></td>
 </tr>
+<tr>
+<td>flatten</td>
+<td><code>Boolean</code></td>
+</tr>
 </tbody>
 </table>
 <p><a name="module_app-builder-lib.Packager+validateConfig"></a></p>

diff --git a/docs/configuration/win.md b/docs/configuration/win.md
@@ -37,7 +37,7 @@ The top-level [win](configuration.md#Configuration-win) key contains set of opti
 <li><code id="WindowsConfiguration-signExts">signExts</code> Array&lt;String&gt; | “undefined” - Explicit file extensions to also sign. Advanced option. See: <a href="https://github.com/electron-userland/electron-builder/issues/7329">https://github.com/electron-userland/electron-builder/issues/7329</a></li>
 </ul>
 <h2 id="windowsazuresigningconfiguration">WindowsAzureSigningConfiguration</h2>
-<p>undefined</p>
+<p>Also allows custom fields <code>[k: string: string]</code> passed verbatim (case sensitive) to Invoke-TrustedSigning</p>
 <ul>
 <li>
 <p><strong><code id="WindowsAzureSigningConfiguration-endpoint">endpoint</code></strong> String - The Trusted Signing Account endpoint. The URI value must have a URI that aligns to the region your Trusted Signing Account and Certificate Profile you are specifying were created in during the setup of these resources.</p>

diff --git a/scripts/jsdoc2md2html.js b/scripts/jsdoc2md2html.js
@@ -217,7 +217,7 @@ async function render2(files, jsdoc2MdOptions) {
     new Page("configuration/pkg.md", "PkgOptions"),
 
     new Page("configuration/win.md", "WindowsConfiguration", {
-      "WindowsAzureSigningConfiguration" : "",
+      "WindowsAzureSigningConfiguration" : "Also allows custom fields `[k: string: string]` passed verbatim (case sensitive) to Invoke-TrustedSigning",
       "WindowsSigntoolConfiguration": ""
     }),
     new Page("configuration/msi-wrapped.md", "MsiWrappedOptions"),