Home Reference Source

Typedef

Static Public Summary
public
public
public
public
public
public
public
public
public

Static Public

public ImportOptions: Object source

Properties:

NameTypeAttributeDescription
dir string
  • optional
  • default: process.cwd()

The path to the app to be imported

interactive boolean
  • optional
  • default: false

Whether to use sensible defaults or prompt the user visually

updateScripts boolean
  • optional
  • default: true

Whether to update the modules package.json scripts to be electron-forge commands

outDir string
  • optional
  • default: `${dir}/out`

The path to the directory containing generated distributables

public InitOptions: Object source

Properties:

NameTypeAttributeDescription
dir string
  • optional
  • default: process.cwd()

The path to the app to be initialized

interactive boolean
  • optional
  • default: false

Whether to use sensible defaults or prompt the user visually

lintStyle string
  • optional
  • default: airbnb

The lintStyle to pass through to the template creator

copyCIFiles boolean
  • optional
  • default: false

Whether to copy Travis and AppVeyor CI files

template string
  • optional

The custom template to use. If left empty, the default template is used

public InstallOptions: Object source

Properties:

NameTypeAttributeDescription
interactive boolean
  • optional
  • default: false

Whether to use sensible defaults or prompt the user visually

prerelease boolean
  • optional
  • default: false

Whether to install prerelease versions

repo string

The GitHub repository to install from, in the format owner/name

chooseAsset function

A function that must return the asset to use/install from a provided array of compatible GitHub assets

public LintOptions: Object source

Properties:

NameTypeAttributeDescription
dir string
  • optional
  • default: process.cwd()

The path to the module to import

interactive boolean
  • optional
  • default: false

Whether to use sensible defaults or prompt the user visually

public MakeOptions: Object source

Properties:

NameTypeAttributeDescription
dir string
  • optional
  • default: process.cwd()

The path to the app from which distributables are generated

interactive boolean
  • optional
  • default: false

Whether to use sensible defaults or prompt the user visually

skipPackage boolean
  • optional
  • default: false

Whether to skip the pre-make packaging step

overrideTargets Array<string>
  • optional

An array of make targets to override your forge config

arch string
  • optional
  • default: host architecture

The target architecture

platform string
  • optional
  • default: process.platform

The target platform.

outDir string
  • optional
  • default: `${dir}/out`

The path to the directory containing generated distributables

public MakeResult: Object source

Properties:

NameTypeAttributeDescription
artifacts Array<string>

An array of paths to artifacts generated for this make run

packageJSON Object

The state of the package.json file when the make happened

platform string

The platform this make run was for

arch string

The arch this make run was for

public PackageOptions: Object source

Properties:

NameTypeAttributeDescription
dir string
  • optional
  • default: process.cwd()

The path to the app to package

interactive boolean
  • optional
  • default: false

Whether to use sensible defaults or prompt the user visually

arch string
  • optional
  • default: process.arch

The target arch

platform string
  • optional
  • default: process.platform

The target platform.

outDir string
  • optional
  • default: `${dir}/out`

The path to the output directory for packaged apps

public PublishOptions: Object source

Properties:

NameTypeAttributeDescription
dir string
  • optional
  • default: process.cwd()

The path to the app to be published

interactive boolean
  • optional
  • default: false

Whether to use sensible defaults or prompt the user visually

authToken string
  • optional

An authentication token to use when publishing

tag string
  • optional
  • default: packageJSON.version

The string to tag this release with

publishTargets Array<string>
  • optional
  • default: [github]

The publish targets

makeOptions MakeOptions
  • optional

Options object to passed through to make()

outDir string
  • optional
  • default: `${dir}/out`

The path to the directory containing generated distributables

dryRun boolean
  • optional
  • default: false

Whether to generate dry run meta data but not actually publish

dryRunResume boolean
  • optional
  • default: false

Whether or not to attempt to resume a previously saved dryRun and publish

makeResults MakeResult
  • optional
  • default: null

Provide results from make so that the publish step doesn't run make itself

public StartOptions: Object source

Properties:

NameTypeAttributeDescription
dir string
  • optional
  • default: process.cwd()

The path to the electron forge project to run

appPath string
  • optional
  • default: '.'

The path (relative to dir) to the electron app to run relative to the project directory

interactive boolean
  • optional
  • default: false

Whether to use sensible defaults or prompt the user visually

enableLogging boolean
  • optional
  • default: false

Enables advanced internal Electron debug calls

args Array<string>
  • optional

Arguments to pass through to the launched Electron application