Skip to main content

Generation Behaviour

What is analysed​

  • Main entry file (PluginOptions.main)
  • Reachable controller files discovered from createIpcApp(...)
  • Preload entry (PluginOptions.preload) to infer API root from setupPreload(...) when statically detectable

Controller resolution paths​

The plugin resolves the controllers value in createIpcApp(...) using three paths, tried in order:

  1. Array literal — controllers: [FooController, BarController] — resolved directly from the array elements.
  2. Call expression with module/class — controllers: getIpcControllers(SomeModule) — follows call arguments to class declarations and reads controllers/providers from decorator metadata.
  3. Resolution strategy fallback — if paths 1 and 2 yield no controllers, the optional resolutionStrategy runs. For example, the "nest" strategy locates NestFactory.createApplicationContext(ModuleClass) and recursively walks @Module({ imports }) to discover controllers.

What is generated​

  • Runtime types module (for importable IpcApi contract)
  • Global declaration file (Window[namespace] augmentation)

Regeneration triggers​

  • Main entry file change
  • Preload entry file change
  • Any tracked controller/dependency file change

Performance behaviour​

  • Generation is debounced (plugin state)
  • Generated output is content-hashed; unchanged output is not rewritten
  • Existing TypeScript Program is reused where possible

Warnings you may see​

  • Main entry not found
  • No createIpcApp() call found (generated API may be empty)
  • Both runtime and global outputs disabled

Practical constraints​

  • Parser expects statically analysable controller wiring in createIpcApp(...)
  • API-root inference is syntax-dependent; dynamic preload patterns may fall back to default ipc
  • Highly dynamic runtime registration patterns may reduce generation accuracy

Parser limitations​

  • Controllers must be discoverable from a static controllers: [...] shape, a supported module/provider pattern, or via a configured resolutionStrategy
  • Namespace inference from preload is limited to statically detectable setupPreload(...) usage
  • When namespace inference is not possible, generated global types default to window.ipc