@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: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/updater/guest-js/index.ts#L50

Properties

Property	Modifier	Type	Inherited from
#private	private	any	Resource.#private
available	public	boolean	-
body?	public	string	-
currentVersion	public	string	-
date?	public	string	-
downloadedBytes?	private	Resource	-
version	public	string	-

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

Parameter	Type
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

Parameter	Type
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

Property	Type	Description
headers?	HeadersInit	Request headers
proxy?	string	A proxy url to be used when checking and downloading updates.
target?	string	Target identifier for the running application. This is sent to the backend.
timeout?	number	Timeout 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

Parameter	Type
options?	CheckOptions

Returns

Promise<Update | null>

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