Class ForgeAPI

Index

Constructors

Methods

make package publish release start

Constructors

constructor

new ForgeAPI(): ForgeAPI
Returns ForgeAPI

Methods

make

make(opts: MakeOptions): Promise<ForgeMakeResult[]>
Make distributables for an Electron application
Parameters
- opts: MakeOptions
Returns Promise<ForgeMakeResult[]>
- Defined in api/core/src/api/index.ts:24

package

package(opts: PackageOptions): Promise<ForgePackageResult[]>
Package an Electron application
Parameters
- opts: PackageOptions
Returns Promise<ForgePackageResult[]>
- Defined in api/core/src/api/index.ts:31

publish

publish(opts: ReleaseOptions): Promise<void>
Publish an Electron application into the given target service
Parameters
- opts: ReleaseOptions
Returns Promise<void>
Deprecated
Use ForgeAPI.release instead. publish is a deprecated alias that will be removed in a future major version.
- Defined in api/core/src/api/index.ts:48

release

release(opts: ReleaseOptions): Promise<void>
Release an Electron application into the given target service
Parameters
- opts: ReleaseOptions
Returns Promise<void>
- Defined in api/core/src/api/index.ts:38

start

start(opts: StartOptions): Promise<ElectronProcess>
Start an Electron application.

Handles things like native module rebuilding for you on the fly
Parameters
- opts: StartOptions
Returns Promise<ElectronProcess>
- Defined in api/core/src/api/index.ts:57