Class ForgeAPI

Hierarchy

ForgeAPI

Index

Constructors

constructor

Methods

Constructors

constructor

new ForgeAPI(): ForgeAPI

Returns ForgeAPI

Methods

import

import(opts: ImportOptions): Promise<void>

- Defined in packages/api/core/src/api/index.ts:19
Attempt to import a given module directory to the Electron Forge standard.
- Sets up git and the correct NPM dependencies
- Adds a template forge config to package.json
Parameters
- opts: ImportOptions
Returns Promise<void>

init

init(opts: InitOptions): Promise<void>

- Defined in packages/api/core/src/api/index.ts:26
Initialize a new Electron Forge template project in the given directory.

Parameters
- opts: InitOptions
Returns Promise<void>

make

make(opts: MakeOptions): Promise<ForgeMakeResult[]>

- Defined in packages/api/core/src/api/index.ts:33
Make distributables for an Electron application

Parameters
- opts: MakeOptions
Returns Promise<ForgeMakeResult[]>

package

package(opts: PackageOptions): Promise<void>

- Defined in packages/api/core/src/api/index.ts:40
Resolves hooks if they are a path to a file (instead of a Function)

Parameters
- opts: PackageOptions
Returns Promise<void>

publish

publish(opts: PublishOptions): Promise<void>

- Defined in packages/api/core/src/api/index.ts:47
Publish an Electron application into the given target service

Parameters
- opts: PublishOptions
Returns Promise<void>

start

start(opts: StartOptions): Promise<ElectronProcess>

- Defined in packages/api/core/src/api/index.ts:56
Start an Electron application.

Handles things like native module rebuilding for you on the fly

Parameters
- opts: StartOptions
Returns Promise<ElectronProcess>