Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ForgeAPI

Hierarchy

  • ForgeAPI

Index

Methods

import

  • 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

    Returns Promise<void>

init

  • Initialize a new Electron Forge template project in the given directory.

    Parameters

    Returns Promise<void>

install

  • Install an Electron application from GitHub.

    Works on all three platforms for all major distributable types.

    Parameters

    Returns Promise<void>

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.

    Parameters

    Returns Promise<void>

make

  • Make distributables for an Electron application

    Parameters

    Returns Promise<ForgeMakeResult[]>

package

  • Resolves hooks if they are a path to a file (instead of a Function)

    Parameters

    Returns Promise<void>

publish

start

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

    Handles things like native module rebuilding for you on the fly

    Parameters

    • opts: StartOptions

    Returns Promise<ChildProcess>