Function
Static Public Summary | ||
public |
async import(providedOptions: ImportOptions): Promise Attempt to import a given module directory to the Electron Forge standard. |
|
public |
async init(providedOptions: InitOptions): Promise Initialize a new Electron Forge template project in the given directory. |
|
public |
async install(providedOptions: InstallOptions): Promise Install an Electron application from GitHub. |
|
public |
async lint(providedOptions: LintOptions): Promise<null, string> Lint a local Electron application. |
|
public |
async make(providedOptions: MakeOptions): Promise<Array<MakeResult>> Make distributables for an Electron application. |
|
public |
async package(providedOptions: PackageOptions): Promise Package an Electron application into an platform dependent format. |
|
public |
async publish(providedOptions: PublishOptions): Promise Publish an Electron application into the given target service. |
|
public |
async start(providedOptions: StartOptions): Promise Start an Electron application. |
Static Public
public async import(providedOptions: ImportOptions): Promise source
import import from 'electron-forge/dist/api/import'
Attempt to import a given module directory to the Electron Forge standard.
- Replaces the prebuilt electron package with the one that integrates with
electron-compile
- Sets up
git
and the correct NPM dependencies - Adds a template forge config to
package.json
Params:
Name | Type | Attribute | Description |
providedOptions | ImportOptions | Options for the import method |
public async init(providedOptions: InitOptions): Promise source
import init from 'electron-forge/dist/api/init'
Initialize a new Electron Forge template project in the given directory.
Params:
Name | Type | Attribute | Description |
providedOptions | InitOptions | Options for the init method |
public async install(providedOptions: InstallOptions): Promise source
import install from 'electron-forge/dist/api/install'
Install an Electron application from GitHub. If you leave interactive as false
, you MUST provide a chooseAsset
function.
Params:
Name | Type | Attribute | Description |
providedOptions | InstallOptions | Options for the install method |
public async lint(providedOptions: LintOptions): Promise<null, string> source
import lint from 'electron-forge/dist/api/lint'
Lint a local Electron application.
The promise will be rejected with the stdout+stderr of the linting process if linting fails or will be resolved if it succeeds.
Params:
Name | Type | Attribute | Description |
providedOptions | LintOptions | Options for the Lint method |
public async make(providedOptions: MakeOptions): Promise<Array<MakeResult>> source
import make from 'electron-forge/dist/api/make'
Make distributables for an Electron application.
Params:
Name | Type | Attribute | Description |
providedOptions | MakeOptions | Options for the make method |
public async package(providedOptions: PackageOptions): Promise source
import package from 'electron-forge/dist/api/package'
Package an Electron application into an platform dependent format.
Params:
Name | Type | Attribute | Description |
providedOptions | PackageOptions | Options for the Package method |
public async publish(providedOptions: PublishOptions): Promise source
import publish from 'electron-forge/dist/api/publish'
Publish an Electron application into the given target service.
Params:
Name | Type | Attribute | Description |
providedOptions | PublishOptions | Options for the Publish method |
public async start(providedOptions: StartOptions): Promise source
import start from 'electron-forge/dist/api/start'
Start an Electron application.
Params:
Name | Type | Attribute | Description |
providedOptions | StartOptions | Options for the Publish method |