vite-plugin-electron-run
    Preparing search index...

    Interface ElectronRunOptions

    Options accepted by createElectronRunner.

    interface ElectronRunOptions {
        additionalArgs?: string[];
        clearScreen?: boolean;
        cwd?: string;
        debounceMs?: number;
        electronPath?: string;
        entry?: string;
        env?: Record<string, string>;
        logger?: LoggerLike;
        manageProcessSignals?: boolean;
        stdinControls?: boolean;
    }
    Index
    additionalArgs? clearScreen? cwd? debounceMs? electronPath? entry? env? logger? manageProcessSignals? stdinControls?
    additionalArgs?: string[]

    Extra CLI args passed to the Electron binary before the entry file.

    clearScreen?: boolean

    Clear the terminal before each launch. Defaults to false.

    cwd?: string

    Working directory for the spawned process. Defaults to process.cwd().

    debounceMs?: number

    Debounce in ms before a rebuild triggers a restart. Defaults to 150.

    electronPath?: string

    Path to the Electron binary to launch. Defaults to resolving the electron package. Set this when the electron package isn't resolvable from this library (e.g. when it's linked into another project).

    Optionalentry

    entry?: string

    Entry file resolved against the bundle output directory. Defaults to main.js.

    env?: Record<string, string>

    Extra environment variables merged onto process.env.

    logger?: LoggerLike

    Custom logger. Defaults to a labelled console logger.

    manageProcessSignals?: boolean

    Install process signal handlers that stop Electron and exit the host process. Defaults to true; embedded hosts such as the Vite plugin default this to false.

    stdinControls?: boolean

    Enable interactive stdin commands (rs, start, stop, …). Defaults to true.

    Settings
    Member Visibility

    On This Page
    Properties