Documentation
    Preparing search index...

    Interface StartOptions

    interface StartOptions {
        appPath?: string;
        args?: (string | number)[];
        dir?: string;
        enableLogging?: boolean;
        inspect?: boolean;
        inspectBrk?: boolean;
        interactive?: boolean;
        runAsNode?: boolean;
    }
    Index

    Properties

    appPath? args? dir? enableLogging? inspect? inspectBrk? interactive? runAsNode?

    Properties

    appPath?: string

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

    args?: (string | number)[]

    Arguments to pass through to the launched Electron application

    dir?: string

    The path to the electron forge project to run

    enableLogging?: boolean

    Enables advanced internal Electron debug calls

    inspect?: boolean

    Enables the node inspector, you can connect to this from chrome://inspect

    inspectBrk?: boolean

    Enables the node inspector, you can connect to this from chrome://inspect Pauses the execution on first JavaScript line until debugger connects.

    interactive?: boolean

    Whether to use sensible defaults or prompt the user visually

    runAsNode?: boolean

    Runs the Electron process as if it were node, disables all Electron API's

    Settings

    Member Visibility

    On This Page

    Properties