Skip to content

Commit

Permalink
fix(docs): update autoupdate docs noting that channels work with Gi…
Browse files Browse the repository at this point in the history
  • Loading branch information
rotu authored May 31, 2024
1 parent 77f9774 commit 48c5953
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 3 deletions.
13 changes: 13 additions & 0 deletions .changeset/selfish-turtles-fold.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
"app-builder-lib": patch
"dmg-builder": patch
"electron-builder": patch
"electron-builder-squirrel-windows": patch
"electron-forge-maker-appimage": patch
"electron-forge-maker-nsis": patch
"electron-forge-maker-nsis-web": patch
"electron-forge-maker-snap": patch
"electron-updater": patch
---

fix(docs): update autoupdate docs noting that channels work with Github
2 changes: 1 addition & 1 deletion docs/api/electron-builder.md
Original file line number Diff line number Diff line change
Expand Up @@ -3397,7 +3397,7 @@ return await getCertInfo(cscFile, cscInfo.password || “”)
<p><code id="AppUpdater-currentVersion">currentVersion</code> SemVer - The current application version.</p>
</li>
<li>
<p><strong><code id="AppUpdater-channel">channel</code></strong> String | “undefined” - Get the update channel. Not applicable for GitHub. Doesn’t return <code>channel</code> from the update configuration, only if was previously set.</p>
<p><strong><code id="AppUpdater-channel">channel</code></strong> String | “undefined” - Get the update channel. Doesn’t return <code>channel</code> from the update configuration, only if was previously set.</p>
</li>
<li>
<p><strong><code id="AppUpdater-requestHeaders">requestHeaders</code></strong> [key: string]: string | “undefined” - The request headers.</p>
Expand Down
4 changes: 2 additions & 2 deletions packages/electron-updater/src/AppUpdater.ts
Original file line number Diff line number Diff line change
Expand Up @@ -123,14 +123,14 @@ export abstract class AppUpdater extends (EventEmitter as new () => TypedEmitter
protected downloadedUpdateHelper: DownloadedUpdateHelper | null = null

/**
* Get the update channel. Not applicable for GitHub. Doesn't return `channel` from the update configuration, only if was previously set.
* Get the update channel. Doesn't return `channel` from the update configuration, only if was previously set.
*/
get channel(): string | null {
return this._channel
}

/**
* Set the update channel. Not applicable for GitHub. Overrides `channel` in the update configuration.
* Set the update channel. Overrides `channel` in the update configuration.
*
* `allowDowngrade` will be automatically set to `true`. If this behavior is not suitable for you, simple set `allowDowngrade` explicitly after.
*/
Expand Down

0 comments on commit 48c5953

Please sign in to comment.