Skip to content

Commit 85843c5

Browse files
automatic update
1 parent f7c7c2a commit 85843c5

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

docs/reference/js/Class.UpdateManager.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Provides functionality for checking for updates, downloading updates, and applyi
66

77
### Constructor
88

9-
> **new UpdateManager**(`urlOrPath`, `options`?, `locator`?): `UpdateManager`
9+
> **new UpdateManager**(`urlOrPath`, `options?`, `locator?`): `UpdateManager`
1010
1111
Create a new UpdateManager instance.
1212

@@ -15,8 +15,8 @@ Create a new UpdateManager instance.
1515
| Parameter | Type | Description |
1616
| ------ | ------ | ------ |
1717
| `urlOrPath` | `string` | Location of the update server or path to the local update directory. |
18-
| `options`? | [`UpdateOptions`](TypeAlias.UpdateOptions.md) | Optional extra configuration for update manager. |
19-
| `locator`? | [`VelopackLocatorConfig`](TypeAlias.VelopackLocatorConfig.md) | Override the default locator configuration (usually used for testing / mocks). |
18+
| `options?` | [`UpdateOptions`](TypeAlias.UpdateOptions.md) | Optional extra configuration for update manager. |
19+
| `locator?` | [`VelopackLocatorConfig`](TypeAlias.VelopackLocatorConfig.md) | Override the default locator configuration (usually used for testing / mocks). |
2020

2121
#### Returns
2222

@@ -39,7 +39,7 @@ UpdateInfo object containing the latest available release, and any delta updates
3939

4040
### downloadUpdateAsync()
4141

42-
> **downloadUpdateAsync**(`update`, `progress`?): `Promise`\<`void`\>
42+
> **downloadUpdateAsync**(`update`, `progress?`): `Promise`\<`void`\>
4343
4444
Downloads the specified updates to the local app packages directory. Progress is reported back to the caller via an optional Sender.
4545
This function will acquire a global update lock so may fail if there is already another update operation in progress.
@@ -53,7 +53,7 @@ This function will acquire a global update lock so may fail if there is already
5353
| Parameter | Type |
5454
| ------ | ------ |
5555
| `update` | [`UpdateInfo`](TypeAlias.UpdateInfo.md) |
56-
| `progress`? | (`perc`) => `void` |
56+
| `progress?` | (`perc`) => `void` |
5757

5858
#### Returns
5959

@@ -113,7 +113,7 @@ On MacOS and Linux this will always be true.
113113

114114
### waitExitThenApplyUpdate()
115115

116-
> **waitExitThenApplyUpdate**(`update`, `silent`?, `restart`?, `restartArgs`?): `void`
116+
> **waitExitThenApplyUpdate**(`update`, `silent?`, `restart?`, `restartArgs?`): `void`
117117
118118
This will launch the Velopack updater and tell it to wait for this program to exit gracefully.
119119
You should then clean up any state and exit your app. The updater will apply updates and then
@@ -124,9 +124,9 @@ optionally restart your app. The updater will only wait for 60 seconds before gi
124124
| Parameter | Type |
125125
| ------ | ------ |
126126
| `update` | [`UpdateInfo`](TypeAlias.UpdateInfo.md) |
127-
| `silent`? | `boolean` |
128-
| `restart`? | `boolean` |
129-
| `restartArgs`? | `string`[] |
127+
| `silent?` | `boolean` |
128+
| `restart?` | `boolean` |
129+
| `restartArgs?` | `string`[] |
130130

131131
#### Returns
132132

0 commit comments

Comments
 (0)