Plugin Options

electronIpcBridge(options?: PluginOptions)

Creates a Vite plugin that parses controller metadata from your main entry and generates renderer-consumable type files.

interface PluginTypesOptions {
  global?: string | false;
  runtime?: string | false;
}

type ResolutionStrategy = "nest";

interface PluginOptions {
  main?: string;
  preload?: string;
  resolutionStrategy?: ResolutionStrategy;
  types?: PluginTypesOptions;
}

Exported Types

The plugin exports the following types for use in your configuration files:

• electronIpcBridgePlugin: The return type of the plugin function.
• PluginOptions: The configuration object interface.

import type { PluginOptions } from "@electron-ipc-bridge/vite-plugin";

Defaults

• main: "src/main/index.ts"
• preload: "src/preload/index.ts"
• resolutionStrategy: undefined (no fallback strategy)
• types.runtime:
  • prefers "src/renderer/src/ipc.types.ts" when src/renderer/src exists
  • otherwise falls back to "src/ipc.types.ts"
• types.global: defaults to preload directory + "ipc.d.ts"

Option semantics

• types.runtime = false: skip runtime type module generation
• types.global = false: skip global Window augmentation generation
• both disabled: plugin logs warning and generates nothing
• types.global requires runtime output (plugin throws if global generation is requested without runtime output)

Resolution strategy

When the controllers value in createIpcApp(...) is a call expression (e.g. getIpcControllers(app)), the plugin first tries to statically resolve controllers from the call's arguments. If that yields nothing, it falls back to the resolutionStrategy — an optional, library-specific resolver.

Strategy	When to use	What it does
"nest"	NestJS apps using NestFactory.createApplicationContext(...)	Finds the root module class, then recursively walks @Module({ imports: [...] }) to discover all controllers

import { electronIpcBridge } from "@electron-ipc-bridge/vite-plugin";

export default {
  plugins: [
    electronIpcBridge({
      resolutionStrategy: "nest",
    }),
  ],
};

info

You only need resolutionStrategy when your controllers are supplied through a runtime helper that the plugin cannot statically trace. If you pass controllers directly as an array literal, or through a statically resolvable module/class reference, no strategy is needed.

Namespace shape in generated globals

If your preload namespace is not a valid JavaScript identifier (for example "my-api"), the generated Window augmentation uses a computed property key (window["my-api"]) rather than dot notation.

Minimal example

import { electronIpcBridge } from "@electron-ipc-bridge/vite-plugin";

export default {
  plugins: [
    electronIpcBridge({
      main: "src/main/index.ts",
      preload: "src/preload/index.ts",
      types: {
        runtime: "src/renderer/src/ipc.types.ts",
        global: "src/preload/ipc.d.ts",
      },
    }),
  ],
};