Documentation
    Preparing search index...
    Index

    Constructors

    Properties

    getElectronVersion: (
        dir: string,
        packageJSON: PackageJSONWithDeps,
    ) => Promise<string> = getElectronVersion
    spawnPackageManager: (
        pm: PMDetails,
        args?: CrossSpawnArgs,
        opts?: CrossSpawnOptions,
    ) => Promise<string> = spawnPackageManager

    Methods

    • Helper for creating a dynamic config value that will get its real value based on the "buildIdentifier" in your Forge config.

      Usage: fromBuildIdentifier({ stable: 'App', beta: 'App Beta' })

      Type Parameters

      • T

      Parameters

      • map: { [key: string]: T | undefined }

      Returns { map: { [key: string]: T | undefined } }

    • Register a virtual config file for forge to find. Takes precedence over other configuration options like a forge.config.js file. Dir should point to the folder containing the app.

      Parameters

      Returns void

    • Unregister a forge config previously registered with registerForgeConfigForDirectory.

      Parameters

      • dir: string

      Returns void