@tauri-apps/plugin-updater
Classes
Update
Extends
Resource
Constructors
new Update()
Parameters
Parameter | Type |
---|---|
metadata | UpdateMetadata |
Returns
Overrides
Resource.constructor
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/updater/guest-js/index.ts#L49
Properties
Property | Modifier | Type | Inherited from |
---|---|---|---|
#private | private | any | Resource.#private |
available | public | boolean | - |
body? | public | string | - |
currentVersion | public | string | - |
date? | public | string | - |
version | public | string | - |
Accessors
rid
Returns
number
Source: undefined
Methods
close()
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: undefined
downloadAndInstall()
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#L59
Interfaces
CheckOptions
Options used to check for updates
Properties
Type Aliases
DownloadEvent
Updater download event
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/updater/guest-js/index.ts#L37
Functions
check()
Check for updates, resolves to null
if no updates are available
Parameters
Parameter | Type |
---|---|
options ? | CheckOptions |
Returns
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/updater/guest-js/index.ts#L74
© 2024 Tauri Contributors. CC-BY / MIT