Interface ElectronUpdater

Source

interface ElectronUpdater {
  /**
   * Checks for available updates from the update server.
   * @param options Optional configuration for the check
   * @param options.allowPrerelease Whether to include prerelease versions (default: false)
   * @returns Promise with update availability and version information
   */
  checkForUpdates: (options?: { allowPrerelease?: boolean }) => Promise<{
    updateAvailable: boolean;
    version?: string;
    releaseNotes?: string;
    releaseDate?: string;
  }>;

  /**
   * Initiates download of an available update.
   * @returns Promise that resolves when download starts
   */
  downloadUpdate: () => Promise<void>;

  /**
   * Quits the application and installs the downloaded update.
   * @returns Promise that resolves before app quits
   */
  installUpdate: () => Promise<void>;

  /**
   * Subscribes to update available events.
   * @param callback Function to call when an update is available
   * @returns Function to unsubscribe from the event
   */
  onUpdateAvailable: (
    callback: (info: {
      version: string;
      releaseNotes: string;
      releaseDate: string;
    }) => void,
  ) => () => void;

  /**
   * Subscribes to download progress events.
   * @param callback Function to call with download progress updates
   * @returns Function to unsubscribe from the event
   */
  onDownloadProgress: (
    callback: (progress: {
      percent: number;
      bytesPerSecond: number;
      transferred: number;
      total: number;
    }) => void,
  ) => () => void;

  /**
   * Subscribes to update downloaded events.
   * @param callback Function to call when download is complete
   * @returns Function to unsubscribe from the event
   */
  onUpdateDownloaded: (
    callback: (info: { version: string }) => void,
  ) => () => void;

  /**
   * Subscribes to update error events.
   * @param callback Function to call when an update error occurs
   * @returns Function to unsubscribe from the event
   */
  onUpdateError: (
    callback: (error: {
      message: string;
      stack?: string;
      name?: string;
    }) => void,
  ) => () => void;
}
Copy