Custom Update Notification Flow

Implement a module that initializes automatic updates for a packaged desktop app and customizes how users are notified once an update is ready to install.

Capabilities

Dialog customization

• When an update has been downloaded, the user prompt uses any provided dialog text overrides for title, detail, restart, and later button labels. @test
• When no overrides are provided, the prompt defaults to a generic restart message that includes the app name. @test

Custom notification handler

• If a notification handler is supplied, it is invoked once per downloaded update with the version, release notes, and a restart callback; calling the callback triggers installation. @test
• If the handler returns without calling the restart callback, the built-in prompt still appears so the user can choose whether to restart. @test

Implementation

@generates

API

export interface DialogText {
  title?: string;
  detail?: string;
  restartButtonText?: string;
  laterButtonText?: string;
}

export interface UpdateNotificationOptions {
  appName: string;
  dialogText?: DialogText;
  notifier?: (info: { version: string; notes?: string | null }, restart: () => void) => void;
}

export function setupUpdateNotifications(options: UpdateNotificationOptions): void;

Dependencies { .dependencies }

update-electron-app { .dependency }

Configures and manages application updates and user notification prompts.