feat: add isUpdateAvailable property to checkForUpdates result (#…

…8829)
electron-userland · Feb 3, 2025 · 14ee2d6 · 14ee2d6
1 parent 44603f2
commit 14ee2d6
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/.changeset/fuzzy-trains-grab.md b/.changeset/fuzzy-trains-grab.md
@@ -0,0 +1,5 @@
+---
+"electron-updater": minor
+---
+
+feat: add `isUpdateAvailable` property to `checkForUpdates` result
diff --git a/packages/electron-updater/src/AppUpdater.ts b/packages/electron-updater/src/AppUpdater.ts
@@ -279,6 +279,7 @@ export abstract class AppUpdater extends (EventEmitter as new () => TypedEmitter
 
   /**
    * Asks the server whether there is an update.
+   * @returns null if the updater is disabled, otherwise info about the latest version
    */
   checkForUpdates(): Promise<UpdateCheckResult | null> {
     if (!this.isUpdaterActive()) {
@@ -461,6 +462,7 @@ export abstract class AppUpdater extends (EventEmitter as new () => TypedEmitter
       )
       this.emit("update-not-available", updateInfo)
       return {
+        isUpdateAvailable: false,
         versionInfo: updateInfo,
         updateInfo,
       }
@@ -472,6 +474,7 @@ export abstract class AppUpdater extends (EventEmitter as new () => TypedEmitter
     const cancellationToken = new CancellationToken()
     //noinspection ES6MissingAwait
     return {
+      isUpdateAvailable: true,
       versionInfo: updateInfo,
       updateInfo,
       cancellationToken,

diff --git a/packages/electron-updater/src/main.ts b/packages/electron-updater/src/main.ts
@@ -77,6 +77,8 @@ export interface ResolvedUpdateFileInfo {
 }
 
 export interface UpdateCheckResult {
+  readonly isUpdateAvailable: boolean
+
   readonly updateInfo: UpdateInfo
 
   readonly downloadPromise?: Promise<Array<string>> | null