Class: NsisUpdater
Extends
Constructors
Constructor
new NsisUpdater(
options?,app?):NsisUpdater
Parameters
options?
AllPublishOptions | null
app?
AppAdapter
Returns
NsisUpdater
Overrides
Properties
_isUpdateSupported
protected_isUpdateSupported:VerifyUpdateSupport
Inherited from
BaseUpdater._isUpdateSupported
_isUserWithinRollout
protected_isUserWithinRollout:VerifyUpdateSupport
Inherited from
BaseUpdater._isUserWithinRollout
_logger
protected_logger:Logger=console
Inherited from
_verifyUpdateCodeSignature
protected_verifyUpdateCodeSignature:VerifyUpdateCodeSignature
allowDowngrade
allowDowngrade:
boolean=false
Whether to allow version downgrade (when a user from the beta channel wants to go back to the stable channel).
Taken in account only if channel differs (pre-release version component in terms of semantic versioning).
Default
false
Inherited from
allowPrerelease
allowPrerelease:
boolean=false
GitHub provider only. Whether to allow update to pre-release versions. Defaults to true if application version contains prerelease components (e.g. 0.12.1-alpha.1, here alpha is a prerelease component), otherwise false.
If true, downgrade will be allowed (allowDowngrade will be set to true).
Inherited from
allowUnverifiedLinuxPackages
allowUnverifiedLinuxPackages:
boolean=true
Linux only. Whether to allow installing unverified (unsigned / failing-GPG) .deb and .rpm packages during auto-update.
electron-builder does not sign Linux packages, so this defaults to true to preserve working auto-updates: the
package manager's signature/GPG checks are bypassed where a bypass flag exists (--allow-unauthenticated for the
apt fallback, --allow-unsigned-rpm for zypper, --nogpgcheck for dnf/yum), which is the historical behavior.
What false enforces depends on the package manager used on the target system:
- dpkg (the default for
.deb): no effect — dpkg performs no signature verification (a warning is logged); enforcing.debsignatures requires a debsig-verify/debsigs policy on the target system. - apt (
.debfallback):--allow-unauthenticatedis omitted. - zypper: enforced — unsigned/untrusted packages fail to install.
- dnf/yum: enforced via
--setopt=localpkg_gpgcheck=1(local package files are not GPG-checked by default). - bare rpm (fallback): cannot be enforced via the CLI (a warning is logged); admins must configure
%_pkgverify_level signatureon the target system.
pacman and AppImage targets are not affected by this option: pacman -U has no per-invocation bypass flag
(local-file policy is LocalFileSigLevel in pacman.conf), and AppImage updates are verified only via the
update-manifest checksum.
Default
true
Inherited from
BaseUpdater.allowUnverifiedLinuxPackages
app
protectedreadonlyapp:AppAdapter
Inherited from
autoDownload
autoDownload:
boolean=true
Whether to automatically download an update when it is found.
Default
true
Inherited from
autoInstallEvent
autoInstallEvent:
AutoInstallEvent="onQuit"
When a downloaded update is automatically installed (if quitAndInstall was not called before).
"onQuit"(default) — install on app quit by spawning the installer while the app exits."onNextLaunch"— defer the install: any app quit persists an install-on-next-launch marker for the downloaded update; on the next launch the updater re-validates the cached installer against freshly fetched update info and installs it (seeinstallPendingUpdateIfAvailable). This avoids the class of failures where the on-quit installer process is killed by the OS before it finishes — most notably Windows terminating the detached NSIS installer during session end (log off / shutdown / restart), which can leave the app uninstalled but not re-installed (see https://github.com/electron-userland/electron-builder/issues/7807). The automatic install at startup only runs for targets that can install without an elevation prompt: NSIS (per-user,isAdminRightsRequired === false) and AppImage. Linux package targets (deb, rpm, pacman) always elevate via pkexec/sudo, and NSIS per-machine installs trigger a UAC prompt, so for those the pending update is kept andinstallPendingUpdateIfAvailable()must be called explicitly at a moment the app controls."manual"— never auto-install; the downloaded update stays cached until an explicitquitAndInstall().
"onNextLaunch" is planned to become the DEFAULT in v28 to resolve this class of bug once and for all.
Default
"onQuit"
Inherited from
autoRunAppAfterInstall
autoRunAppAfterInstall:
boolean=true
Whether to run the app after finish install when run the installer is NOT in silent mode.
Default
true
Inherited from
BaseUpdater.autoRunAppAfterInstall
currentVersion
readonlycurrentVersion:SemVer
The current application version.
Inherited from
disableDifferentialDownload
disableDifferentialDownload:
boolean=false
NSIS only Disable differential downloads and always perform full download of installer.
Default
false
Inherited from
AppImageUpdater.disableDifferentialDownload
downloadedUpdateHelper
protecteddownloadedUpdateHelper:DownloadedUpdateHelper|null=null
Inherited from
BaseUpdater.downloadedUpdateHelper
forceDevUpdateConfig
forceDevUpdateConfig:
boolean=false
Allows developer to force the updater to work in "dev" mode, looking for "dev-app-update.yml" instead of "app-update.yml"
Dev: path.join(this.app.getAppPath(), "dev-app-update.yml")
Prod: path.join(process.resourcesPath!, "app-update.yml")
Default
false
Inherited from
AppImageUpdater.forceDevUpdateConfig
fullChangelog
fullChangelog:
boolean=false
GitHub provider only. Get all release notes (from current version to latest), not just the latest.
Default
false
Inherited from
installDirectory?
optionalinstallDirectory?:string
Specify custom install directory path
previousBlockmapBaseUrlOverride
previousBlockmapBaseUrlOverride:
string|null=null
The base URL of the old block map file.
When null, the updater will use the base URL of the update file to download the update. When set, the updater will use this string as the base URL of the old block map file. Some servers like github cannot download the old block map file from latest release, so you need to compute the old block map file base URL manually.
Default
null
Inherited from
AppImageUpdater.previousBlockmapBaseUrlOverride
quitAndInstallCalled
protectedquitAndInstallCalled:boolean=false
Inherited from
BaseUpdater.quitAndInstallCalled
requestHeaders
requestHeaders:
OutgoingHttpHeaders|null=null
The request headers.
Inherited from
AppImageUpdater.requestHeaders
signals
readonlysignals:UpdaterSignal
For type safety you can use signals, e.g. autoUpdater.signals.updateDownloaded(() => {}) instead of autoUpdater.on('update-available', () => {})
Inherited from
stagingUserIdPromise
protectedreadonlystagingUserIdPromise:Lazy<string>
Inherited from
AppImageUpdater.stagingUserIdPromise
updateInfoAndProvider
protectedupdateInfoAndProvider:UpdateInfoAndProvider|null=null
Inherited from
BaseUpdater.updateInfoAndProvider
updateManifestPublicKey
updateManifestPublicKey:
string|string[] |null=null
The Ed25519 public key(s) (PEM or base64 SPKI) trusted to have signed the update manifest — the
install's trust list. A single string or an array of keys; a manifest is accepted when any listed key
validates one of its signatures. When set (non-empty), overrides the updateManifestPublicKey value
embedded in app-update.yml.
When at least one key is available (here or in config) the manifest signature is enforced and a download will not start unless verification succeeds. When no key is available, verification is skipped (opt-in) and a one-time warning is logged.
Inherited from
AppImageUpdater.updateManifestPublicKey
Accessors
autoInstallOnAppQuit
Get Signature
get autoInstallOnAppQuit():
boolean
Deprecated
Removed in v27 — use autoInstallEvent. This accessor is a compatibility shim and will be deleted in v28.
A boolean cannot express the three install timings, so autoInstallOnAppQuit was replaced rather
than extended. Without this shim the property assignment silently no-ops on a plain object: an app
that set autoInstallOnAppQuit = false to opt out of install-on-quit would keep the "onQuit"
default and install on quit anyway — the exact opposite of what it asked for.
Returns
boolean
Set Signature
set autoInstallOnAppQuit(
value):void
Parameters
value
boolean
Returns
void
Inherited from
BaseUpdater.autoInstallOnAppQuit
channel
Get Signature
get channel():
string|null
Get the update channel. Doesn't return channel from the update configuration, only if was previously set.
Returns
string | null
Set Signature
set channel(
value):void
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.
Parameters
value
string | null
Returns
void
Inherited from
disableWebInstaller
Get Signature
get disableWebInstaller():
boolean
Whether to block NSIS web-installer packages. Web installer files might not have signature verification, so they are disabled by default as of v27.
v27 grace period: apps that do not explicitly set this property will warn (but still download) if a web-installer update is received. In v28 the warning becomes an error and the download is blocked (ERR_UPDATER_WEB_INSTALLER_DISABLED). Apps that explicitly set this to true throw immediately. Set it to false only if you intentionally publish and rely on NSIS web-installer packages.
Default
true
Returns
boolean
Set Signature
set disableWebInstaller(
value):void
Parameters
value
boolean
Returns
void
Inherited from
AppImageUpdater.disableWebInstaller
installerPath
Get Signature
get
protectedinstallerPath():string|null
Returns
string | null
Inherited from
isAutoInstallOnNextLaunchSupported
Get Signature
get
protectedisAutoInstallOnNextLaunchSupported():boolean
Whether this target supports the automatic autoInstallEvent: "onNextLaunch" install at startup. Targets whose install
always requires elevation (deb/rpm/pacman via pkexec/sudo) must not show an authentication prompt at app launch,
so they keep the pending update for an explicit installPendingUpdateIfAvailable() call instead.
Returns
boolean
Overrides
BaseUpdater.isAutoInstallOnNextLaunchSupported
isUpdateSupported
Get Signature
get isUpdateSupported():
VerifyUpdateSupport
Allows developer to override default logic for determining if an update is supported.
The default logic compares the UpdateInfo minimum system version against the os.release() with semver package
Returns
Set Signature
set isUpdateSupported(
value):void
Parameters
value
Returns
void
Inherited from
isUserWithinRollout
Get Signature
get isUserWithinRollout():
VerifyUpdateSupport
Allows developer to override default logic for determining if the user is below the rollout threshold. The default logic compares the staging percentage with numerical representation of user ID. An override can define custom logic, or bypass it if needed.
Returns
Set Signature
set isUserWithinRollout(
value):void
Parameters
value
Returns
void
Inherited from
BaseUpdater.isUserWithinRollout
logger
Get Signature
get logger():
Logger|null
The logger. You can pass electron-log, winston or another logger with the following interface: { info(), warn(), error() }.
Set it to null if you would like to disable a logging feature.
Returns
Logger | null
Set Signature
set logger(
value):void
Parameters
value
Logger | null
Returns
void
Inherited from
netSession
Get Signature
get netSession():
Session
Returns
Session
Inherited from
verifyUpdateCodeSignature
Get Signature
get verifyUpdateCodeSignature():
VerifyUpdateCodeSignature
The verifyUpdateCodeSignature. You can pass win-verify-signature or another custom verify function: (publisherName: string[], path: string) => Promise<string | null>.
The default verify function uses windowsExecutableCodeSignatureVerifier
Returns
Set Signature
set verifyUpdateCodeSignature(
value):void
Parameters
value
Returns
void
Methods
addAuthHeader()
addAuthHeader(
token):void
Shortcut for explicitly adding auth tokens to request headers
Parameters
token
string
Returns
void
Inherited from
addListener()
addListener<
U>(event,listener):this
Type Parameters
U
U extends keyof AppUpdaterEvents
Parameters
event
U
listener
AppUpdaterEvents[U]
Returns
this
Inherited from
addQuitHandler()
protectedaddQuitHandler():void
Returns
void
Inherited from
checkForUpdates()
checkForUpdates():
Promise<UpdateCheckResult|null>
Asks the server whether there is an update.
Returns
Promise<UpdateCheckResult | null>
null if the updater is disabled, otherwise info about the latest version
Inherited from
checkForUpdatesAndNotify()
checkForUpdatesAndNotify(
downloadNotification?):Promise<UpdateCheckResult|null>
Parameters
downloadNotification?
DownloadNotification
Returns
Promise<UpdateCheckResult | null>
Inherited from
BaseUpdater.checkForUpdatesAndNotify
differentialDownloadInstaller()
protecteddifferentialDownloadInstaller(fileInfo,downloadUpdateOptions,installerPath,provider,oldInstallerFileName):Promise<boolean>
Parameters
fileInfo
downloadUpdateOptions
DownloadUpdateOptions
installerPath
string
provider
Provider<any>
oldInstallerFileName
string
Returns
Promise<boolean>
Inherited from
BaseUpdater.differentialDownloadInstaller
dispatchError()
protecteddispatchError(e):void
Parameters
e
Error
Returns
void
Inherited from
dispatchUpdateDownloaded()
protecteddispatchUpdateDownloaded(event):void
Parameters
event
Returns
void
Inherited from
BaseUpdater.dispatchUpdateDownloaded
doInstall()
protecteddoInstall(options):boolean
Parameters
options
InstallOptions
Returns
boolean
Overrides
downloadUpdate()
downloadUpdate(
cancellationToken?):Promise<DownloadExecutorResult>
Start downloading update manually. You can use this method if autoDownload option is set to false.
Parameters
cancellationToken?
CancellationToken = ...
Returns
Promise<DownloadExecutorResult>
The downloaded files: updateFile is the path to the downloaded update (installer, AppImage, zip, ...),
packageFile is the path to the NSIS web installer package and is only set for web installers.
Inherited from
emit()
emit<
U>(event, ...args):boolean
Type Parameters
U
U extends keyof AppUpdaterEvents
Parameters
event
U
args
...Parameters<AppUpdaterEvents[U]>
Returns
boolean
Inherited from
eventNames()
eventNames<
U>():U[]
Type Parameters
U
U extends keyof AppUpdaterEvents
Returns
U[]
Inherited from
executeDownload()
protectedexecuteDownload(taskOptions):Promise<DownloadExecutorResult>
Parameters
taskOptions
DownloadExecutorTask
Returns
Promise<DownloadExecutorResult>
Inherited from
getFeedURL()
getFeedURL():
string|null|undefined
Returns
string | null | undefined
Inherited from
getMaxListeners()
getMaxListeners():
number
Returns
number
Inherited from
getOrCreateDownloadHelper()
protectedgetOrCreateDownloadHelper():Promise<DownloadedUpdateHelper>
Returns
Promise<DownloadedUpdateHelper>
Inherited from
BaseUpdater.getOrCreateDownloadHelper
getUpdateInfoAndProvider()
protectedgetUpdateInfoAndProvider():Promise<UpdateInfoAndProvider>
Returns
Promise<UpdateInfoAndProvider>
Inherited from
BaseUpdater.getUpdateInfoAndProvider
install()
install(
isSilent?,isForceRunAfter?):boolean
Parameters
isSilent?
boolean = false
isForceRunAfter?
boolean = false
Returns
boolean
Inherited from
installPendingUpdateIfAvailable()
installPendingUpdateIfAvailable():
Promise<boolean>
Installs an update that a previous launch marked as pending (see autoInstallEvent: "onNextLaunch" and
quitAndInstall({ waitUntilNextLaunch: true })), then quits the app.
The cached installer is never trusted blindly: a fresh update-info fetch is performed first and the cached file
is validated against it (checksum, and code signature where applicable). The pending update is only installed
when its version is an installable change from the running app — newer, or older when allowDowngrade is set
(a loop guard, mirroring isUpdateAvailable); otherwise the pending state is cleared.
Unlike the automatic startup install, an explicit call is also allowed for targets whose install requires
elevation: NSIS per-machine installations (isAdminRightsRequired === true) and Linux package targets
(deb, rpm, pacman — installed via pkexec/sudo).
On macOS this resolves to false: Squirrel.Mac already stages downloaded updates natively and applies them when
the app is relaunched after quit, so there is no pending-install state managed by electron-updater.
Returns
Promise<boolean>
true if a pending update was validated and its installation was initiated (the app will quit).
Inherited from
BaseUpdater.installPendingUpdateIfAvailable
isUpdaterActive()
isUpdaterActive():
boolean
Returns
boolean
Inherited from
listenerCount()
listenerCount(
type):number
Parameters
type
keyof AppUpdaterEvents
Returns
number
Inherited from
listeners()
listeners<
U>(type):AppUpdaterEvents[U][]
Type Parameters
U
U extends keyof AppUpdaterEvents
Parameters
type
U
Returns
AppUpdaterEvents[U][]
Inherited from
off()
off<
U>(event,listener):this
Type Parameters
U
U extends keyof AppUpdaterEvents
Parameters
event
U
listener
AppUpdaterEvents[U]
Returns
this
Inherited from
on()
on<
U>(event,listener):this
Type Parameters
U
U extends keyof AppUpdaterEvents
Parameters
event
U
listener
AppUpdaterEvents[U]
Returns
this
Inherited from
once()
once<
U>(event,listener):this
Type Parameters
U
U extends keyof AppUpdaterEvents
Parameters
event
U
listener
AppUpdaterEvents[U]
Returns
this
Inherited from
onUpdateAvailable()
protectedonUpdateAvailable(updateInfo):void
Parameters
updateInfo
Returns
void
Inherited from
prependListener()
prependListener<
U>(event,listener):this
Type Parameters
U
U extends keyof AppUpdaterEvents
Parameters
event
U
listener
AppUpdaterEvents[U]
Returns
this
Inherited from
prependOnceListener()
prependOnceListener<
U>(event,listener):this
Type Parameters
U
U extends keyof AppUpdaterEvents
Parameters
event
U
listener
AppUpdaterEvents[U]
Returns
this
Inherited from
BaseUpdater.prependOnceListener
quitAndInstall()
quitAndInstall(
options?,legacyIsForceRunAfter?):void
Restarts the app and installs the update after it has been downloaded.
It should only be called after update-downloaded has been emitted.
Note: autoUpdater.quitAndInstall() will close all application windows first and only emit before-quit event on app after that.
This is different from the normal quit event sequence.
Parameters
options?
boolean | QuitAndInstallOptions
See QuitAndInstallOptions. When omitted, the installer runs non-silent and the deferred install-on-next-launch flow is not used (same behavior as before the options object was introduced).
legacyIsForceRunAfter?
boolean
Returns
void
Inherited from
rawListeners()
rawListeners<
U>(type):AppUpdaterEvents[U][]
Type Parameters
U
U extends keyof AppUpdaterEvents
Parameters
type
U
Returns
AppUpdaterEvents[U][]
Inherited from
removeAllListeners()
removeAllListeners(
event?):this
Parameters
event?
keyof AppUpdaterEvents
Returns
this
Inherited from
BaseUpdater.removeAllListeners
removeListener()
removeListener<
U>(event,listener):this
Type Parameters
U
U extends keyof AppUpdaterEvents
Parameters
event
U
listener
AppUpdaterEvents[U]
Returns
this
Inherited from
sanitizeEnvPath()
protectedsanitizeEnvPath(envPath):string
Strips relative-path entries from a PATH string. Prevents PATH-poisoning where a writable directory earlier in PATH shadows a trusted package manager binary.
Parameters
envPath
string
Returns
string
Inherited from
setFeedURL()
setFeedURL(
options):void
Configure update provider. If value is string, GenericServerOptions will be set with value as url.
Parameters
options
PublishConfiguration | AllPublishOptions
If you want to override configuration in the app-update.yml.
Returns
void
Inherited from
setMaxListeners()
setMaxListeners(
n):this
Parameters
n
number
Returns
this
Inherited from
spawnLog()
protectedspawnLog(cmd,args?,env?,stdio?):Promise<boolean>
This handles both node 8 and node 10 way of emitting error when spawning a process
- node 8: Throws the error
- node 10: Emit the error(Need to listen with on)
Parameters
cmd
string
args?
string[] = []
env?
any = undefined
stdio?
StdioOptions = "ignore"
Returns
Promise<boolean>
Inherited from
spawnSyncLog()
protectedspawnSyncLog(cmd,args?,env?):string
Parameters
cmd
string
args?
string[] = []
env?
Returns
string
Inherited from
verifyInstallerSignatureOnLaunch()
protectedverifyInstallerSignatureOnLaunch(installerPath):Promise<string|null>
Re-verification of the cached installer's code signature before an install-on-next-launch is executed.
Platforms without installer signature verification resolve to null (no error).
Parameters
installerPath
string
Returns
Promise<string | null>