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#L62

Properties

PropertyTypeDefined in
availablebooleanSource: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/updater/guest-js/index.ts#L55
body?stringSource: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/updater/guest-js/index.ts#L59
currentVersionstringSource: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/updater/guest-js/index.ts#L56
date?stringSource: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/updater/guest-js/index.ts#L58
versionstringSource: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/updater/guest-js/index.ts#L57

Accessors

rid
get rid(): number
Returns

number

Inherited from

Resource.rid

Source: undefined

Methods

close()
close(): Promise<void>

Destroys and cleans up this resource from memory. You should not call any method on this object anymore and should drop any reference to it.

Returns

Promise<void>

Overrides

Resource.close

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

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

Download the updater package

Parameters
ParameterType
onEvent?(progress) => void
options?DownloadOptions
Returns

Promise<void>

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

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

Downloads the updater package and installs it

Parameters
ParameterType
onEvent?(progress) => void
options?DownloadOptions
Returns

Promise<void>

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

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#L89

Interfaces

CheckOptions

Options used when checking for updates

Properties

PropertyTypeDescriptionDefined in
headers?HeadersInitRequest headersSource: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/updater/guest-js/index.ts#L12
proxy?stringA proxy url to be used when checking and downloading updates.Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/updater/guest-js/index.ts#L20
target?stringTarget identifier for the running application. This is sent to the backend.Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/updater/guest-js/index.ts#L24
timeout?numberTimeout in millisecondsSource: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/updater/guest-js/index.ts#L16

DownloadOptions

Options used when downloading an update

Properties

PropertyTypeDescriptionDefined in
headers?HeadersInitRequest headersSource: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/updater/guest-js/index.ts#L32
timeout?numberTimeout in millisecondsSource: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/updater/guest-js/index.ts#L36

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#L49

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#L126


© 2024 Tauri Contributors. CC-BY / MIT