@tauri-apps/plugin-updater

Classes

Update

Extends

• Resource

Constructors

constructor()

new Update(metadata): Update

Parameters

Parameter	Type
metadata	UpdateMetadata

Returns

Update

Overrides

Resource.constructor

Source: plugins/updater/guest-js/index.ts:49

Properties

Property	Type
private #private	any
available	boolean
body?	string
currentVersion	string
date?	string
version	string

Accessors

rid

get rid(): number

Source: node_modules/.pnpm/@tauri-apps+api@2.0.0-alpha.13/node_modules/@tauri-apps/api/core.d.ts:123

Inherited from

Resource.rid

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 >

Inherited from

Resource.close

Source: node_modules/.pnpm/@tauri-apps+api@2.0.0-alpha.13/node_modules/@tauri-apps/api/core.d.ts:129

---

downloadAndInstall()

downloadAndInstall(onEvent?): Promise< void >

Downloads the updater package and installs it

Parameters

Parameter	Type
onEvent?	(progress) => void

Returns

Promise< void >

Source: plugins/updater/guest-js/index.ts:59

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

DownloadEvent: {data: {contentLength: number;}; event: "Started";} | {data: {chunkLength: number;}; event: "Progress";} | {event: "Finished";}

Updater download event

Source: plugins/updater/guest-js/index.ts:37

Functions

check()

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: plugins/updater/guest-js/index.ts:74