electron-forge
Version:
A complete tool for building modern Electron applications
904 lines (595 loc) • 30.9 kB
HTML
<html>
<head>
<meta charset="utf-8">
<base data-ice="baseUrl" href="../">
<title data-ice="title">Function | API Document</title>
<link type="text/css" rel="stylesheet" href="css/style.css">
<link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css">
<script src="script/prettify/prettify.js"></script>
<script src="script/manual.js"></script>
</head>
<body class="layout-container" data-ice="rootContainer">
<header>
<a href="./">Home</a>
<a href="identifiers.html">Reference</a>
<a href="source.html">Source</a>
<a data-ice="repoURL" href="https://github.com/electron-userland/electron-forge" class="repo-url-github">Repository</a>
<div class="search-box">
<span>
<img src="./image/search.png">
<span class="search-input-edge"></span><input class="search-input"><span class="search-input-edge"></span>
</span>
<ul class="search-result"></ul>
</div>
</header>
<nav class="navigation" data-ice="nav"><div>
<ul>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-import">import</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-init">init</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-install">install</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-lint">lint</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-make">make</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-package">package</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-publish">publish</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-start">start</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-ImportOptions">ImportOptions</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-InitOptions">InitOptions</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-InstallOptions">InstallOptions</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-LintOptions">LintOptions</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-MakeOptions">MakeOptions</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-PackageOptions">PackageOptions</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-PublishOptions">PublishOptions</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-StartOptions">StartOptions</a></span></span></li>
</ul>
</div>
</nav>
<div class="content" data-ice="content"><h1 data-ice="title">Function</h1>
<div data-ice="summaries"><table class="summary" data-ice="summary">
<thead><tr><td data-ice="title" colspan="3">Static Public Summary</td></tr></thead>
<tbody>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="async">async</span>
<span data-ice="name"><span><a href="function/index.html#static-function-import">import</a></span></span><span data-ice="signature">(providedOptions: <span><a href="typedef/index.html#static-typedef-ImportOptions">ImportOptions</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Attempt to import a given module directory to the Electron Forge standard.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="async">async</span>
<span data-ice="name"><span><a href="function/index.html#static-function-init">init</a></span></span><span data-ice="signature">(providedOptions: <span><a href="typedef/index.html#static-typedef-InitOptions">InitOptions</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Initialize a new Electron Forge template project in the given directory.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="async">async</span>
<span data-ice="name"><span><a href="function/index.html#static-function-install">install</a></span></span><span data-ice="signature">(providedOptions: <span><a href="typedef/index.html#static-typedef-InstallOptions">InstallOptions</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Install an Electron application from GitHub.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="async">async</span>
<span data-ice="name"><span><a href="function/index.html#static-function-lint">lint</a></span></span><span data-ice="signature">(providedOptions: <span><a href="typedef/index.html#static-typedef-LintOptions">LintOptions</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span><<span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/null">null</a></span>, <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>></span>
</p>
</div>
<div>
<div data-ice="description"><p>Lint a local Electron application.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="async">async</span>
<span data-ice="name"><span><a href="function/index.html#static-function-make">make</a></span></span><span data-ice="signature">(providedOptions: <span><a href="typedef/index.html#static-typedef-MakeOptions">MakeOptions</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Make distributables for an Electron application.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="async">async</span>
<span data-ice="name"><span><a href="function/index.html#static-function-package">package</a></span></span><span data-ice="signature">(providedOptions: <span><a href="typedef/index.html#static-typedef-PackageOptions">PackageOptions</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Package an Electron application into an platform dependent format.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="async">async</span>
<span data-ice="name"><span><a href="function/index.html#static-function-publish">publish</a></span></span><span data-ice="signature">(providedOptions: <span><a href="typedef/index.html#static-typedef-PublishOptions">PublishOptions</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Publish an Electron application into the given target service.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="async">async</span>
<span data-ice="name"><span><a href="function/index.html#static-function-start">start</a></span></span><span data-ice="signature">(providedOptions: <span><a href="typedef/index.html#static-typedef-StartOptions">StartOptions</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Start an Electron application.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
</tbody>
</table>
</div>
<div data-ice="details"><h2 data-ice="title">Static Public </h2>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-function-import">
<span class="access" data-ice="access">public</span>
<span data-ice="async">async</span>
<span data-ice="name">import</span><span data-ice="signature">(providedOptions: <span><a href="typedef/index.html#static-typedef-ImportOptions">ImportOptions</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/api/import.js.html#lineNumber33">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import import from '<span><a href="file/api/import.js.html#lineNumber33">electron-forge/dist/api/import</a></span>'</code></pre></div>
<div data-ice="description"><p>Attempt to import a given module directory to the Electron Forge standard.</p>
<ul>
<li>Replaces the prebuilt electron package with the one that integrates with <code>electron-compile</code></li>
<li>Sets up <code>git</code> and the correct NPM dependencies</li>
<li>Adds a template forge config to <code>package.json</code></li>
</ul>
</div>
<div data-ice="properties"><div data-ice="properties">
<h4 data-ice="title">Params:</h4>
<table class="params">
<thead>
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
</thead>
<tbody>
<tr data-ice="property" data-depth="0">
<td data-ice="name" data-depth="0">providedOptions</td>
<td data-ice="type"><span><a href="typedef/index.html#static-typedef-ImportOptions">ImportOptions</a></span></td>
<td data-ice="appendix"></td>
<td data-ice="description"><p>Options for the import method</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="return-params" data-ice="returnParams">
<h4>Return:</h4>
<table>
<tbody>
<tr>
<td class="return-type" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></td>
<td class="return-desc" data-ice="returnDescription"><p>Will resolve when the import process is complete</p>
</td>
</tr>
</tbody>
</table>
<div data-ice="returnProperties">
</div>
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-function-init">
<span class="access" data-ice="access">public</span>
<span data-ice="async">async</span>
<span data-ice="name">init</span><span data-ice="signature">(providedOptions: <span><a href="typedef/index.html#static-typedef-InitOptions">InitOptions</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/api/init.js.html#lineNumber28">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import init from '<span><a href="file/api/init.js.html#lineNumber28">electron-forge/dist/api/init</a></span>'</code></pre></div>
<div data-ice="description"><p>Initialize a new Electron Forge template project in the given directory.</p>
</div>
<div data-ice="properties"><div data-ice="properties">
<h4 data-ice="title">Params:</h4>
<table class="params">
<thead>
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
</thead>
<tbody>
<tr data-ice="property" data-depth="0">
<td data-ice="name" data-depth="0">providedOptions</td>
<td data-ice="type"><span><a href="typedef/index.html#static-typedef-InitOptions">InitOptions</a></span></td>
<td data-ice="appendix"></td>
<td data-ice="description"><p>Options for the init method</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="return-params" data-ice="returnParams">
<h4>Return:</h4>
<table>
<tbody>
<tr>
<td class="return-type" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></td>
<td class="return-desc" data-ice="returnDescription"><p>Will resolve when the initialization process is complete</p>
</td>
</tr>
</tbody>
</table>
<div data-ice="returnProperties">
</div>
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-function-install">
<span class="access" data-ice="access">public</span>
<span data-ice="async">async</span>
<span data-ice="name">install</span><span data-ice="signature">(providedOptions: <span><a href="typedef/index.html#static-typedef-InstallOptions">InstallOptions</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/api/install.js.html#lineNumber38">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import install from '<span><a href="file/api/install.js.html#lineNumber38">electron-forge/dist/api/install</a></span>'</code></pre></div>
<div data-ice="description"><p>Install an Electron application from GitHub. If you leave interactive as <code>false</code>, you MUST provide a <code>chooseAsset</code> function.</p>
</div>
<div data-ice="properties"><div data-ice="properties">
<h4 data-ice="title">Params:</h4>
<table class="params">
<thead>
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
</thead>
<tbody>
<tr data-ice="property" data-depth="0">
<td data-ice="name" data-depth="0">providedOptions</td>
<td data-ice="type"><span><a href="typedef/index.html#static-typedef-InstallOptions">InstallOptions</a></span></td>
<td data-ice="appendix"></td>
<td data-ice="description"><p>Options for the install method</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="return-params" data-ice="returnParams">
<h4>Return:</h4>
<table>
<tbody>
<tr>
<td class="return-type" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></td>
<td class="return-desc" data-ice="returnDescription"><p>Will resolve when the install process is complete</p>
</td>
</tr>
</tbody>
</table>
<div data-ice="returnProperties">
</div>
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-function-lint">
<span class="access" data-ice="access">public</span>
<span data-ice="async">async</span>
<span data-ice="name">lint</span><span data-ice="signature">(providedOptions: <span><a href="typedef/index.html#static-typedef-LintOptions">LintOptions</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span><<span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/null">null</a></span>, <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/api/lint.js.html#lineNumber25">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import lint from '<span><a href="file/api/lint.js.html#lineNumber25">electron-forge/dist/api/lint</a></span>'</code></pre></div>
<div data-ice="description"><p>Lint a local Electron application.</p>
<p>The promise will be rejected with the stdout+stderr of the linting process if linting fails or
will be resolved if it succeeds.</p>
</div>
<div data-ice="properties"><div data-ice="properties">
<h4 data-ice="title">Params:</h4>
<table class="params">
<thead>
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
</thead>
<tbody>
<tr data-ice="property" data-depth="0">
<td data-ice="name" data-depth="0">providedOptions</td>
<td data-ice="type"><span><a href="typedef/index.html#static-typedef-LintOptions">LintOptions</a></span></td>
<td data-ice="appendix"></td>
<td data-ice="description"><p>Options for the Lint method</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="return-params" data-ice="returnParams">
<h4>Return:</h4>
<table>
<tbody>
<tr>
<td class="return-type" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span><<span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/null">null</a></span>, <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>></td>
<td class="return-desc" data-ice="returnDescription"><p>Will resolve when the lint process is complete</p>
</td>
</tr>
</tbody>
</table>
<div data-ice="returnProperties">
</div>
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-function-make">
<span class="access" data-ice="access">public</span>
<span data-ice="async">async</span>
<span data-ice="name">make</span><span data-ice="signature">(providedOptions: <span><a href="typedef/index.html#static-typedef-MakeOptions">MakeOptions</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/api/make.js.html#lineNumber30">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import make from '<span><a href="file/api/make.js.html#lineNumber30">electron-forge/dist/api/make</a></span>'</code></pre></div>
<div data-ice="description"><p>Make distributables for an Electron application.</p>
</div>
<div data-ice="properties"><div data-ice="properties">
<h4 data-ice="title">Params:</h4>
<table class="params">
<thead>
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
</thead>
<tbody>
<tr data-ice="property" data-depth="0">
<td data-ice="name" data-depth="0">providedOptions</td>
<td data-ice="type"><span><a href="typedef/index.html#static-typedef-MakeOptions">MakeOptions</a></span></td>
<td data-ice="appendix"></td>
<td data-ice="description"><p>Options for the make method</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="return-params" data-ice="returnParams">
<h4>Return:</h4>
<table>
<tbody>
<tr>
<td class="return-type" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></td>
<td class="return-desc" data-ice="returnDescription"><p>Will resolve when the make process is complete</p>
</td>
</tr>
</tbody>
</table>
<div data-ice="returnProperties">
</div>
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-function-package">
<span class="access" data-ice="access">public</span>
<span data-ice="async">async</span>
<span data-ice="name">package</span><span data-ice="signature">(providedOptions: <span><a href="typedef/index.html#static-typedef-PackageOptions">PackageOptions</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/api/package.js.html#lineNumber30">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import package from '<span><a href="file/api/package.js.html#lineNumber30">electron-forge/dist/api/package</a></span>'</code></pre></div>
<div data-ice="description"><p>Package an Electron application into an platform dependent format.</p>
</div>
<div data-ice="properties"><div data-ice="properties">
<h4 data-ice="title">Params:</h4>
<table class="params">
<thead>
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
</thead>
<tbody>
<tr data-ice="property" data-depth="0">
<td data-ice="name" data-depth="0">providedOptions</td>
<td data-ice="type"><span><a href="typedef/index.html#static-typedef-PackageOptions">PackageOptions</a></span></td>
<td data-ice="appendix"></td>
<td data-ice="description"><p>Options for the Package method</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="return-params" data-ice="returnParams">
<h4>Return:</h4>
<table>
<tbody>
<tr>
<td class="return-type" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></td>
<td class="return-desc" data-ice="returnDescription"><p>Will resolve when the package process is complete</p>
</td>
</tr>
</tbody>
</table>
<div data-ice="returnProperties">
</div>
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-function-publish">
<span class="access" data-ice="access">public</span>
<span data-ice="async">async</span>
<span data-ice="name">publish</span><span data-ice="signature">(providedOptions: <span><a href="typedef/index.html#static-typedef-PublishOptions">PublishOptions</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/api/publish.js.html#lineNumber27">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import publish from '<span><a href="file/api/publish.js.html#lineNumber27">electron-forge/dist/api/publish</a></span>'</code></pre></div>
<div data-ice="description"><p>Publish an Electron application into the given target service.</p>
</div>
<div data-ice="properties"><div data-ice="properties">
<h4 data-ice="title">Params:</h4>
<table class="params">
<thead>
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
</thead>
<tbody>
<tr data-ice="property" data-depth="0">
<td data-ice="name" data-depth="0">providedOptions</td>
<td data-ice="type"><span><a href="typedef/index.html#static-typedef-PublishOptions">PublishOptions</a></span></td>
<td data-ice="appendix"></td>
<td data-ice="description"><p>Options for the Publish method</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="return-params" data-ice="returnParams">
<h4>Return:</h4>
<table>
<tbody>
<tr>
<td class="return-type" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></td>
<td class="return-desc" data-ice="returnDescription"><p>Will resolve when the publish process is complete</p>
</td>
</tr>
</tbody>
</table>
<div data-ice="returnProperties">
</div>
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-function-start">
<span class="access" data-ice="access">public</span>
<span data-ice="async">async</span>
<span data-ice="name">start</span><span data-ice="signature">(providedOptions: <span><a href="typedef/index.html#static-typedef-StartOptions">StartOptions</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/api/start.js.html#lineNumber24">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import start from '<span><a href="file/api/start.js.html#lineNumber24">electron-forge/dist/api/start</a></span>'</code></pre></div>
<div data-ice="description"><p>Start an Electron application.</p>
</div>
<div data-ice="properties"><div data-ice="properties">
<h4 data-ice="title">Params:</h4>
<table class="params">
<thead>
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
</thead>
<tbody>
<tr data-ice="property" data-depth="0">
<td data-ice="name" data-depth="0">providedOptions</td>
<td data-ice="type"><span><a href="typedef/index.html#static-typedef-StartOptions">StartOptions</a></span></td>
<td data-ice="appendix"></td>
<td data-ice="description"><p>Options for the Publish method</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="return-params" data-ice="returnParams">
<h4>Return:</h4>
<table>
<tbody>
<tr>
<td class="return-type" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></td>
<td class="return-desc" data-ice="returnDescription"><p>Will resolve when the application is launched</p>
</td>
</tr>
</tbody>
</table>
<div data-ice="returnProperties">
</div>
</div>
</div>
</div>
</div>
<footer class="footer">
Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(0.5.2)</span><img src="./image/esdoc-logo-mini-black.png"></a>
</footer>
<script src="script/search_index.js"></script>
<script src="script/search.js"></script>
<script src="script/pretty-print.js"></script>
<script src="script/inherited-summary.js"></script>
<script src="script/test-summary.js"></script>
<script src="script/inner-link.js"></script>
<script src="script/patch-for-local.js"></script>
</body>
</html>