@tauri-apps/plugin-updater

Functions

check()

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

Defined in: plugins/updater/guest-js/index.ts:159

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

Parameters

Parameter	Type
options?	CheckOptions

Returns

Promise<Update | null>

Classes

Update

Defined in: plugins/updater/guest-js/index.ts:66

Extends

• Resource

Constructors

new Update()

new Update(metadata: UpdateMetadata): Update;

Defined in: plugins/updater/guest-js/index.ts:77

Parameters

Parameter	Type
metadata	UpdateMetadata

Returns

Update

Overrides

Resource.constructor

Properties

Property	Type	Description	Defined in
available	boolean	Deprecated This is always true, check if the return value is null instead when using check	plugins/updater/guest-js/index.ts:69
body?	string	-	plugins/updater/guest-js/index.ts:73
currentVersion	string	-	plugins/updater/guest-js/index.ts:70
date?	string	-	plugins/updater/guest-js/index.ts:72
rawJson	Record<string, unknown>	-	plugins/updater/guest-js/index.ts:74
version	string	-	plugins/updater/guest-js/index.ts:71

Accessors

rid

Get Signature

get rid(): number;

Defined in: @tauri-apps/api/core.d.ts:183

Returns

number

Inherited from

Resource.rid

Methods

close()

close(): Promise<void>;

Defined in: plugins/updater/guest-js/index.ts:152

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

download()

download(onEvent?: (progress: DownloadEvent) => void, options?: DownloadOptions): Promise<void>;

Defined in: plugins/updater/guest-js/index.ts:88

Download the updater package. Call install later to install it

Parameters

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

Returns

Promise<void>

downloadAndInstall()

downloadAndInstall(onEvent?: (progress: DownloadEvent) => void, options?: DownloadOptions & InstallOptions): Promise<void>;

Defined in: plugins/updater/guest-js/index.ts:136

Downloads the updater package and installs it

Platform-specific

• Windows: This function exits the app after launching the updater installer successfully
• macOS / Linux: You need to relaunch the app to run the newly install version

Parameters

Parameter	Type
onEvent?	(progress: DownloadEvent) => void
options?	DownloadOptions & InstallOptions

Returns

Promise<void>

install()

install(options?: InstallOptions): Promise<void>;

Defined in: plugins/updater/guest-js/index.ts:113

Install downloaded updater package. Must be called after download.

Platform-specific

• Windows: This function exits the app after launching the updater installer successfully
• macOS / Linux: You need to relaunch the app to run the newly install version

Parameters

Parameter	Type
options?	InstallOptions

Returns

Promise<void>

Interfaces

CheckOptions

Defined in: plugins/updater/guest-js/index.ts:8

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.	plugins/updater/guest-js/index.ts:28
headers?	HeadersInit	Request headers	plugins/updater/guest-js/index.ts:12
proxy?	string	A proxy url to be used when checking and downloading updates.	plugins/updater/guest-js/index.ts:20
target?	string	Target identifier for the running application. This is sent to the backend.	plugins/updater/guest-js/index.ts:24
timeout?	number	Timeout in milliseconds	plugins/updater/guest-js/index.ts:16

---

DownloadOptions

Defined in: plugins/updater/guest-js/index.ts:32

Options used when downloading an update

Properties

Property	Type	Description	Defined in
headers?	HeadersInit	Request headers	plugins/updater/guest-js/index.ts:36
timeout?	number	Timeout in milliseconds	plugins/updater/guest-js/index.ts:40

Type Aliases

DownloadEvent

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

Defined in: plugins/updater/guest-js/index.ts:61

Updater download event