torque-pro-assistant - v1.0.0
    Preparing search index...

    Interface ElectronAPI

    Single source of truth for the contextBridge surface exposed in preload.ts. The renderer reads this via the Window augmentation in src/global.d.ts; the preload imports it to satisfy the contextBridge shape. Keep these three in lock-step:

    • preload.ts (publishes electronAPI)
    • src/global.d.ts (augments Window)
    • src/types/electron-api.ts (this file — the contract)
    interface ElectronAPI {
        getPort: () => number;
        maximize: () => void;
        minimize: () => void;
        openExternal: (url: string) => void;
        platform: Platform;
        quit: () => void;
        unmaximize: () => void;
    }
    Index

    Properties

    getPort maximize minimize openExternal platform quit unmaximize

    Properties

    getPort: () => number

    Returns the Flask port assigned by main.js. Synchronous so renderer code can use the value at module load time without an extra await.

    maximize: () => void
    minimize: () => void
    openExternal: (url: string) => void

    Hands a URL off to the host OS's default browser via Electron's shell.openExternal. Used by Settings → About to route to the repo / docs / issue tracker without spawning a new BrowserWindow. The renderer never sees the URL after dispatch — main.ts owns the shell module.

    platform: Platform

    Host platform string (process.platform) — 'win32' | 'darwin' | 'linux' etc. Read once at preload time so the renderer can pick a platform- appropriate chrome (e.g. native macOS traffic lights vs. custom Windows window controls) without round-tripping IPC.

    quit: () => void
    unmaximize: () => void

    Settings

    Member Visibility

    On This Page

    Properties