Skip to content

Commit

Permalink
docs: channel works with Github
Browse files Browse the repository at this point in the history
The `channel` option was documented as not working with GitHub, but it *does* work. Updated docs accordingly.
  • Loading branch information
rotu committed May 21, 2024
1 parent 77f9774 commit 2ddafdc
Showing 1 changed file with 2 additions and 2 deletions.
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 2ddafdc

Please sign in to comment.