electron updater.Class.BaseUpdater

Electron-Builder / electron-updater / BaseUpdater

Extends¶

AppUpdater

Extended by¶

Constructors¶

new BaseUpdater()¶

protected new BaseUpdater(options?, app?): BaseUpdater

Parameters¶

• options?: null | AllPublishOptions

• app?: AppAdapter

Returns¶

BaseUpdater

Overrides¶

AppUpdater.constructor

Properties¶

quitAndInstallCalled¶

protected quitAndInstallCalled: boolean = false

Methods¶

addQuitHandler()¶

protected addQuitHandler(): void

Returns¶

void

doInstall()¶

abstract protected doInstall(options): boolean

Parameters¶

• options: InstallOptions

Returns¶

boolean

executeDownload()¶

protected executeDownload(taskOptions): Promise<string[]>

Parameters¶

• taskOptions: DownloadExecutorTask

Returns¶

Promise<string[]>

Overrides¶

AppUpdater.executeDownload

install()¶

install(isSilent, isForceRunAfter): boolean

Parameters¶

• isSilent: boolean = false

• isForceRunAfter: boolean = false

Returns¶

boolean

quitAndInstall()¶

quitAndInstall(isSilent, isForceRunAfter): 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¶

• isSilent: boolean = false

windows-only Runs the installer in silent mode. Defaults to false.

• isForceRunAfter: boolean = false

Run the app after finish even on silent install. Not applicable for macOS. Ignored if isSilent is set to false(In this case you can still set autoRunAppAfterInstall to false to prevent run the app after finish).

Returns¶

void

Overrides¶

AppUpdater.quitAndInstall

spawnLog()¶

protected spawnLog(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>

spawnSyncLog()¶

protected spawnSyncLog(cmd, args, env): string

Parameters¶

• cmd: string

• args: string[] = []

• env = {}

Returns¶

string

wrapSudo()¶

protected wrapSudo(): string

Returns¶

string