Skip to content
Tauri

@tauri-apps/plugin-updater

Classes

Update

Extends

  • Resource

Constructors

new Update()
new Update(metadata): Update
Parameters
ParameterType
metadataUpdateMetadata
Returns

Update

Overrides

Resource.constructor

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/updater/guest-js/index.ts#L50

Properties

PropertyModifierTypeInherited from
#privateprivateanyResource.#private
availablepublicboolean-
body?publicstring-
currentVersionpublicstring-
date?publicstring-
downloadedBytes?privateResource-
versionpublicstring-

Accessors

rid
get rid(): number
Returns

number

Source: undefined

Methods

close()
close(): Promise<void>
Returns

Promise<void>

Overrides

Resource.close

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/updater/guest-js/index.ts#L101

download()
download(onEvent?): Promise<void>

Download the updater package

Parameters
ParameterType
onEvent?(progress) => void
Returns

Promise<void>

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/updater/guest-js/index.ts#L60

downloadAndInstall()
downloadAndInstall(onEvent?): Promise<void>

Downloads the updater package and installs it

Parameters
ParameterType
onEvent?(progress) => void
Returns

Promise<void>

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/updater/guest-js/index.ts#L88

install()
install(): Promise<void>

Install downloaded updater package

Returns

Promise<void>

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/updater/guest-js/index.ts#L73

Interfaces

CheckOptions

Options used to check for updates

Properties

PropertyTypeDescription
headers?HeadersInitRequest headers
proxy?stringA proxy url to be used when checking and downloading updates.
target?stringTarget identifier for the running application. This is sent to the backend.
timeout?numberTimeout in seconds

Type Aliases

DownloadEvent

type DownloadEvent: object | object | object;

Updater download event

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/updater/guest-js/index.ts#L37

Functions

check()

function check(options?): Promise<Update | null>

Check for updates, resolves to null if no updates are available

Parameters

ParameterType
options?CheckOptions

Returns

Promise<Update | null>

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/updater/guest-js/index.ts#L108


© 2024 Tauri Contributors. CC-BY / MIT