electron-ipc-module
    Preparing search index...

    Interface IpcBridgeOptions

    User-facing options for the Rollup bridge plugin.

    interface IpcBridgeOptions {
        expose?: string;
        ipcDir?: string;
        logger?: LoggerLike;
        outFile?: string;
        tsconfig?: string;
    }
    Index
    expose? ipcDir? logger? outFile? tsconfig?
    expose?: string

    Global key to expose the bridge under, e.g. "ipc" for window.ipc.

    When set, the generated file also calls contextBridge.exposeInMainWorld and declares the matching Window member, so the exposed key and the type the renderer sees are produced from one source instead of two hand-written files that can drift apart.

    Must be a new global identifier. Generation rejects names declared by the installed TypeScript DOM/ES libraries; Electron rejects runtime-specific globals rather than overwriting them.

    Left unset the bridge is only exported, and wiring both up is yours to do.

    ipcDir?: string

    Directory or glob of *.ipc.ts files. Defaults to ./src/ipc.

    logger?: LoggerLike

    Where generation progress and analyzer warnings go. Defaults to a labelled console logger that prints info and above.

    Supply one to silence the generator in a watch loop, to route output into a build tool's own reporter, or to see the per-module debug detail the default logger drops.

    outFile?: string

    Path of the generated bridge file. Defaults to ./src/generated/ipc-bridge.ts.

    tsconfig?: string

    tsconfig used to type-check the analyzed files. Defaults to ./tsconfig.json.

    Settings
    Member Visibility

    On This Page
    Properties