@tauri-apps/plugin-updater

Classes

Update

Extends

• Resource

Constructors

new Update()

new Update(metadata): Update

Parameters

Parameter	Type
metadata	UpdateMetadata

Returns

Update

Overrides

Resource.constructor

Source: undefined

Properties

Property	Type	Description	Defined in
available	boolean	Deprecated This is always true, check if the return value is null instead when using check	Source: undefined
body?	string	-	Source: undefined
currentVersion	string	-	Source: undefined
date?	string	-	Source: undefined
rawJson	Record<string, unknown>	-	Source: undefined
version	string	-	Source: undefined

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: undefined

download()

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

Download the updater package

Parameters

Parameter	Type
onEvent?	(progress) => void
options?	DownloadOptions

Returns

Promise<void>

Source: undefined

downloadAndInstall()

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

Downloads the updater package and installs it

Parameters

Parameter	Type
onEvent?	(progress) => void
options?	DownloadOptions

Returns

Promise<void>

Source: undefined

install()

install(): Promise<void>

Install downloaded updater package

Returns

Promise<void>

Source: undefined

Interfaces

CheckOptions

Options used when checking for updates

Properties

Property	Type	Description	Defined in
allowDowngrades?	boolean	Allow downgrades to previous versions by not checking if the current version is greater than the available version.	Source: undefined
headers?	HeadersInit	Request headers	Source: undefined
proxy?	string	A proxy url to be used when checking and downloading updates.	Source: undefined
target?	string	Target identifier for the running application. This is sent to the backend.	Source: undefined
timeout?	number	Timeout in milliseconds	Source: undefined

---

DownloadOptions

Options used when downloading an update

Properties

Property	Type	Description	Defined in
headers?	HeadersInit	Request headers	Source: undefined
timeout?	number	Timeout in milliseconds	Source: undefined

Type Aliases

DownloadEvent

type DownloadEvent: object | object | object;

Updater download event

Source: undefined

Functions

check()

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

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

Parameters

Parameter	Type
options?	CheckOptions

Returns

Promise<Update | null>

Source: undefined