electron updater.Class.NsisUpdater

允许开发者强制更新程序在“dev”模式下工作，查找 “dev-app-update.yml” 而不是 “app-update.yml”。开发环境: path.join(this.app.getAppPath(), "dev-app-update.yml") 生产环境: path.join(process.resourcesPath!, "app-update.yml")

默认¶

false

继承自¶

BaseUpdater.forceDevUpdateConfig

fullChangelog¶

fullChangelog: boolean = false

仅 GitHub 提供程序。 获取所有发行说明 (从当前版本到最新版本)，而不仅仅是最新的。

默认¶

false

继承自¶

BaseUpdater.fullChangelog

installDirectory?¶

optional installDirectory: string

指定自定义安装目录路径

quitAndInstallCalled¶

protected quitAndInstallCalled: boolean = false

继承自¶

BaseUpdater.quitAndInstallCalled

requestHeaders¶

requestHeaders: null | OutgoingHttpHeaders = null

请求标头。

继承自¶

BaseUpdater.requestHeaders

signals¶

readonly signals: UpdaterSignal

为了类型安全，您可以使用信号，例如 autoUpdater.signals.updateDownloaded(() => {}) 而不是 autoUpdater.on('update-available', () => {})

继承自¶

BaseUpdater.signals

stagingUserIdPromise¶

protected readonly stagingUserIdPromise: Lazy<string>

继承自¶

BaseUpdater.stagingUserIdPromise

updateInfoAndProvider¶

protected updateInfoAndProvider: null | UpdateInfoAndProvider = null

继承自¶

BaseUpdater.updateInfoAndProvider

访问器¶

channel¶

get channel(): null | string

获取更新频道。不返回更新配置中的 channel，仅当先前设置时才返回。

set channel(value): void

设置更新频道。覆盖更新配置中的 channel。

allowDowngrade 将自动设置为 true。如果此行为不适合您，请在之后显式设置 allowDowngrade。

参数¶

• value: null | string

返回值¶

null | string

继承自¶

BaseUpdater.channel

installerPath¶

get protected installerPath(): null | string

返回值¶

null | string

继承自¶

BaseUpdater.installerPath

isUpdateSupported¶

get isUpdateSupported(): VerifyUpdateSupport

允许开发者覆盖用于确定是否支持更新的默认逻辑。默认逻辑将 UpdateInfo 的最低系统版本与使用 semver 包的 os.release() 进行比较

set isUpdateSupported(value): void

logger¶

get logger(): null | Logger

日志记录器。您可以传递 electron-log、winston 或另一个具有以下接口的日志记录器: { info(), warn(), error() }。如果您想禁用日志记录功能，请将其设置为 null。

set logger(value): void

参数¶

• value: null | Logger

返回值¶

null | Logger

继承自¶

BaseUpdater.logger

netSession¶

get netSession(): Session

返回值¶

Session

继承自¶

BaseUpdater.netSession

verifyUpdateCodeSignature¶

get verifyUpdateCodeSignature(): VerifyUpdateCodeSignature

verifyUpdateCodeSignature。您可以传递 win-verify-signature 或另一个自定义验证函数：(publisherName: string[], path: string) => Promise<string | null>。默认验证函数使用 windowsExecutableCodeSignatureVerifier

set verifyUpdateCodeSignature(value): void

参数¶

• value: VerifyUpdateCodeSignature

返回值¶

VerifyUpdateCodeSignature

方法¶

addAuthHeader()¶

addAuthHeader(token): void

显式将身份验证令牌添加到请求标头的快捷方式

参数¶

• token: string

返回值¶

void

继承自¶

BaseUpdater.addAuthHeader

addListener()¶

addListener<U>(event, listener): this

类型参数¶

• U extends keyof AppUpdaterEvents

参数¶

• event: U

• listener: AppUpdaterEvents[U]

返回值¶

this

继承自¶

BaseUpdater.addListener

addQuitHandler()¶

protected addQuitHandler(): void

返回值¶

void

继承自¶

BaseUpdater.addQuitHandler

checkForUpdates()¶

checkForUpdates(): Promise<null | UpdateCheckResult>

询问服务器是否有更新。

返回值¶

Promise<null | UpdateCheckResult>

如果更新程序被禁用，则为 null，否则为有关最新版本的信息

继承自¶

BaseUpdater.checkForUpdates

checkForUpdatesAndNotify()¶

checkForUpdatesAndNotify(downloadNotification?): Promise<null | UpdateCheckResult>

参数¶

• downloadNotification?: DownloadNotification

返回值¶

Promise<null | UpdateCheckResult>

继承自¶

BaseUpdater.checkForUpdatesAndNotify

differentialDownloadInstaller()¶

protected differentialDownloadInstaller(fileInfo, downloadUpdateOptions, installerPath, provider, oldInstallerFileName): Promise<boolean>

参数¶

• fileInfo: ResolvedUpdateFileInfo

• downloadUpdateOptions: DownloadUpdateOptions

• installerPath: string

• provider: Provider<any>

• oldInstallerFileName: string

返回值¶

Promise<boolean>

继承自¶

BaseUpdater.differentialDownloadInstaller

dispatchError()¶

protected dispatchError(e): void

参数¶

• e: Error

返回值¶

void

继承自¶

BaseUpdater.dispatchError

dispatchUpdateDownloaded()¶

protected dispatchUpdateDownloaded(event): void

参数¶

• event: UpdateDownloadedEvent

返回值¶

void

继承自¶

BaseUpdater.dispatchUpdateDownloaded

doInstall()¶

protected doInstall(options): boolean

参数¶

• options: InstallOptions

返回值¶

boolean

覆盖¶

BaseUpdater.doInstall

downloadUpdate()¶

downloadUpdate(cancellationToken): Promise<string[]>

开始手动下载更新。如果 autoDownload 选项设置为 false，则可以使用此方法。

参数¶

• cancellationToken: CancellationToken = ...

返回值¶

Promise<string[]>

下载文件的路径。

继承自¶

BaseUpdater.downloadUpdate

emit()¶

emit<U>(event, …args): boolean

类型参数¶

• U extends keyof AppUpdaterEvents

参数¶

• event: U

• …args: Parameters<AppUpdaterEvents[U]>

返回值¶

boolean

继承自¶

BaseUpdater.emit

eventNames()¶

eventNames<U>(): U[]

类型参数¶

• U extends keyof AppUpdaterEvents

返回值¶

U[]

继承自¶

BaseUpdater.eventNames

executeDownload()¶

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

参数¶

• taskOptions: DownloadExecutorTask

返回值¶

Promise<string[]>

继承自¶

BaseUpdater.executeDownload

getFeedURL()¶

getFeedURL(): undefined | null | string

返回值¶

undefined | null | string

继承自¶

BaseUpdater.getFeedURL

getMaxListeners()¶

getMaxListeners(): number

返回值¶

number

继承自¶

BaseUpdater.getMaxListeners

getUpdateInfoAndProvider()¶

protected getUpdateInfoAndProvider(): Promise<UpdateInfoAndProvider>

返回值¶

Promise<UpdateInfoAndProvider>

继承自¶

BaseUpdater.getUpdateInfoAndProvider

install()¶

install(isSilent, isForceRunAfter): boolean

参数¶

• isSilent: boolean = false

• isForceRunAfter: boolean = false

返回值¶

boolean

继承自¶

BaseUpdater.install

isUpdaterActive()¶

isUpdaterActive(): boolean

返回值¶

boolean

继承自¶

BaseUpdater.isUpdaterActive

listenerCount()¶

listenerCount(type): number

参数¶

• type: keyof AppUpdaterEvents

返回值¶

number

继承自¶

BaseUpdater.listenerCount

listeners()¶

listeners<U>(type): AppUpdaterEvents[U][]

类型参数¶

• U extends keyof AppUpdaterEvents

参数¶

• type: U

返回值¶

AppUpdaterEvents[U][]

继承自¶

BaseUpdater.listeners

off()¶

off<U>(event, listener): this

类型参数¶

• U extends keyof AppUpdaterEvents

参数¶

• event: U

• listener: AppUpdaterEvents[U]

返回值¶

this

继承自¶

BaseUpdater.off

on()¶

on<U>(event, listener): this

类型参数¶

• U extends keyof AppUpdaterEvents

参数¶

• event: U

• listener: AppUpdaterEvents[U]

返回值¶

this

继承自¶

BaseUpdater.on

once()¶

once<U>(event, listener): this

类型参数¶

• U extends keyof AppUpdaterEvents

参数¶

• event: U

• listener: AppUpdaterEvents[U]

返回值¶

this

继承自¶

BaseUpdater.once

onUpdateAvailable()¶

protected onUpdateAvailable(updateInfo): void

参数¶

• updateInfo: UpdateInfo

返回值¶

void

继承自¶

BaseUpdater.onUpdateAvailable

prependListener()¶

prependListener<U>(event, listener): this

类型参数¶

• U extends keyof AppUpdaterEvents

参数¶

• event: U

• listener: AppUpdaterEvents[U]

返回值¶

this

继承自¶

BaseUpdater.prependListener

prependOnceListener()¶

prependOnceListener<U>(event, listener): this

类型参数¶

• U extends keyof AppUpdaterEvents

参数¶

• event: U

• listener: AppUpdaterEvents[U]

返回值¶

this

继承自¶

BaseUpdater.prependOnceListener

quitAndInstall()¶

quitAndInstall(isSilent, isForceRunAfter): void

重启应用并在下载完成后安装更新。它应该只在 update-downloaded 事件发出后被调用。

注意： autoUpdater.quitAndInstall() 会首先关闭所有应用程序窗口，然后才在 app 上发出 before-quit 事件。这与正常的退出事件序列不同。

参数¶

• isSilent: boolean = false

仅限 Windows 以静默模式运行安装程序。默认为 false。

• isForceRunAfter: boolean = false

即使在静默安装后也运行应用程序。不适用于 macOS。如果 isSilent 设置为 false 则忽略（在这种情况下，您仍然可以设置 autoRunAppAfterInstall 为 false 以防止在完成后运行应用程序）。

返回值¶

void

继承自¶

BaseUpdater.quitAndInstall

rawListeners()¶

rawListeners<U>(type): AppUpdaterEvents[U][]

类型参数¶

• U extends keyof AppUpdaterEvents

参数¶

• type: U

返回值¶

AppUpdaterEvents[U][]

继承自¶

BaseUpdater.rawListeners

removeAllListeners()¶

removeAllListeners(event?): this

参数¶

• event?: keyof AppUpdaterEvents

返回值¶

this

继承自¶

BaseUpdater.removeAllListeners

removeListener()¶

removeListener<U>(event, listener): this

类型参数¶

• U extends keyof AppUpdaterEvents

参数¶

• event: U

• listener: AppUpdaterEvents[U]

返回值¶

this

继承自¶

BaseUpdater.removeListener

setFeedURL()¶

setFeedURL(options): void

配置更新提供程序。如果值为 string，则 GenericServerOptions 将被设置为以该值作为 url。

参数¶

• options: PublishConfiguration | AllPublishOptions

如果您想覆盖 app-update.yml 中的配置。

返回值¶

void

继承自¶

BaseUpdater.setFeedURL

setMaxListeners()¶

setMaxListeners(n): this

参数¶

• n: number

返回值¶

this

继承自¶

BaseUpdater.setMaxListeners

spawnLog()¶

protected spawnLog(cmd, args, env, stdio): Promise<boolean>

这处理了 node 8 和 node 10 在生成进程时发出错误的方式 - node 8：抛出错误 - node 10：发出错误（需要使用 on 监听）。

参数¶

• cmd: string

• args: string[] = []

• env: any = undefined

• stdio: StdioOptions = "ignore"

返回值¶

Promise<boolean>

继承自¶

BaseUpdater.spawnLog

spawnSyncLog()¶

protected spawnSyncLog(cmd, args, env): string

参数¶

• cmd: string

• args: string[] = []

• env = {}

返回值¶

字符串

继承自¶

BaseUpdater.spawnSyncLog

wrapSudo()¶

protected wrapSudo(): string

返回值¶

字符串

继承自¶

BaseUpdater.wrapSudo