Skip to content

Commit 0e10645

Browse files
github-actions[bot]github-actions[bot]
committed
automatic update
1 parent a3db9c3 commit 0e10645

6 files changed

Lines changed: 45 additions & 31 deletions

File tree

‎docs/reference/js/Class.UpdateManager.md‎

Lines changed: 2 additions & 2 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
### new UpdateManager()
88

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

@@ -20,7 +20,7 @@ Create a new UpdateManager instance.
2020

2121
#### Returns
2222

23-
[`UpdateManager`](Class.UpdateManager.md)
23+
`UpdateManager`
2424

2525
## Methods
2626

‎docs/reference/js/Class.VelopackApp.md‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@ This should be used as early as possible in your application startup code.
88

99
### new VelopackApp()
1010

11-
> **new VelopackApp**(): [`VelopackApp`](Class.VelopackApp.md)
11+
> **new VelopackApp**(): `VelopackApp`
1212
1313
#### Returns
1414

15-
[`VelopackApp`](Class.VelopackApp.md)
15+
`VelopackApp`
1616

1717
## Methods
1818

1919
### onAfterInstallFastCallback()
2020

21-
> **onAfterInstallFastCallback**(`callback`): [`VelopackApp`](Class.VelopackApp.md)
21+
> **onAfterInstallFastCallback**(`callback`): `VelopackApp`
2222
2323
WARNING: FastCallback hooks are run during critical stages of Velopack operations.
2424
Your code will be run and then the process will exit.
@@ -33,13 +33,13 @@ Only supported on windows; On other operating systems, this will never be called
3333

3434
#### Returns
3535

36-
[`VelopackApp`](Class.VelopackApp.md)
36+
`VelopackApp`
3737

3838
***
3939

4040
### onAfterUpdateFastCallback()
4141

42-
> **onAfterUpdateFastCallback**(`callback`): [`VelopackApp`](Class.VelopackApp.md)
42+
> **onAfterUpdateFastCallback**(`callback`): `VelopackApp`
4343
4444
WARNING: FastCallback hooks are run during critical stages of Velopack operations.
4545
Your code will be run and then the process will exit.
@@ -54,13 +54,13 @@ Only supported on windows; On other operating systems, this will never be called
5454

5555
#### Returns
5656

57-
[`VelopackApp`](Class.VelopackApp.md)
57+
`VelopackApp`
5858

5959
***
6060

6161
### onBeforeUninstallFastCallback()
6262

63-
> **onBeforeUninstallFastCallback**(`callback`): [`VelopackApp`](Class.VelopackApp.md)
63+
> **onBeforeUninstallFastCallback**(`callback`): `VelopackApp`
6464
6565
WARNING: FastCallback hooks are run during critical stages of Velopack operations.
6666
Your code will be run and then the process will exit.
@@ -75,13 +75,13 @@ Only supported on windows; On other operating systems, this will never be called
7575

7676
#### Returns
7777

78-
[`VelopackApp`](Class.VelopackApp.md)
78+
`VelopackApp`
7979

8080
***
8181

8282
### onBeforeUpdateFastCallback()
8383

84-
> **onBeforeUpdateFastCallback**(`callback`): [`VelopackApp`](Class.VelopackApp.md)
84+
> **onBeforeUpdateFastCallback**(`callback`): `VelopackApp`
8585
8686
WARNING: FastCallback hooks are run during critical stages of Velopack operations.
8787
Your code will be run and then the process will exit.
@@ -96,13 +96,13 @@ Only supported on windows; On other operating systems, this will never be called
9696

9797
#### Returns
9898

99-
[`VelopackApp`](Class.VelopackApp.md)
99+
`VelopackApp`
100100

101101
***
102102

103103
### onFirstRun()
104104

105-
> **onFirstRun**(`callback`): [`VelopackApp`](Class.VelopackApp.md)
105+
> **onFirstRun**(`callback`): `VelopackApp`
106106
107107
This hook is triggered when the application is started for the first time after installation.
108108

@@ -114,13 +114,13 @@ This hook is triggered when the application is started for the first time after
114114

115115
#### Returns
116116

117-
[`VelopackApp`](Class.VelopackApp.md)
117+
`VelopackApp`
118118

119119
***
120120

121121
### onRestarted()
122122

123-
> **onRestarted**(`callback`): [`VelopackApp`](Class.VelopackApp.md)
123+
> **onRestarted**(`callback`): `VelopackApp`
124124
125125
This hook is triggered when the application is restarted by Velopack after installing updates.
126126

@@ -132,7 +132,7 @@ This hook is triggered when the application is restarted by Velopack after insta
132132

133133
#### Returns
134134

135-
[`VelopackApp`](Class.VelopackApp.md)
135+
`VelopackApp`
136136

137137
***
138138

@@ -151,7 +151,7 @@ In some circumstances it may terminate/restart the process to perform tasks.
151151

152152
### setArgs()
153153

154-
> **setArgs**(`args`): [`VelopackApp`](Class.VelopackApp.md)
154+
> **setArgs**(`args`): `VelopackApp`
155155
156156
Override the command line arguments used by VelopackApp. (by default this is env::args().skip(1))
157157

@@ -163,13 +163,13 @@ Override the command line arguments used by VelopackApp. (by default this is env
163163

164164
#### Returns
165165

166-
[`VelopackApp`](Class.VelopackApp.md)
166+
`VelopackApp`
167167

168168
***
169169

170170
### setAutoApplyOnStartup()
171171

172-
> **setAutoApplyOnStartup**(`autoApply`): [`VelopackApp`](Class.VelopackApp.md)
172+
> **setAutoApplyOnStartup**(`autoApply`): `VelopackApp`
173173
174174
Set whether to automatically apply downloaded updates on startup. This is ON by default.
175175

@@ -181,13 +181,13 @@ Set whether to automatically apply downloaded updates on startup. This is ON by
181181

182182
#### Returns
183183

184-
[`VelopackApp`](Class.VelopackApp.md)
184+
`VelopackApp`
185185

186186
***
187187

188188
### setLocator()
189189

190-
> **setLocator**(`locator`): [`VelopackApp`](Class.VelopackApp.md)
190+
> **setLocator**(`locator`): `VelopackApp`
191191
192192
VelopackLocator provides some utility functions for locating the current app important paths (eg. path to packages, update binary, and so forth).
193193

@@ -199,16 +199,16 @@ VelopackLocator provides some utility functions for locating the current app imp
199199

200200
#### Returns
201201

202-
[`VelopackApp`](Class.VelopackApp.md)
202+
`VelopackApp`
203203

204204
***
205205

206206
### build()
207207

208-
> `static` **build**(): [`VelopackApp`](Class.VelopackApp.md)
208+
> `static` **build**(): `VelopackApp`
209209
210210
Build a new VelopackApp instance.
211211

212212
#### Returns
213213

214-
[`VelopackApp`](Class.VelopackApp.md)
214+
`VelopackApp`

‎docs/reference/js/TypeAlias.UpdateInfo.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Type Alias: UpdateInfo
22

3-
> **UpdateInfo**: `object`
3+
> **UpdateInfo** = `object`
44
55
Holds information about the current version and pending updates, such as how many there are, and access to release notes.
66

7-
## Type declaration
7+
## Properties
88

99
### IsDowngrade
1010

@@ -14,6 +14,8 @@ True if the update is a version downgrade or lateral move (such as when switchin
1414
In this case, only full updates are allowed, and any local packages on disk newer than the downloaded version will be
1515
deleted.
1616

17+
***
18+
1719
### TargetFullRelease
1820

1921
> **TargetFullRelease**: `VelopackAsset`

‎docs/reference/js/TypeAlias.UpdateOptions.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Type Alias: UpdateOptions
22

3-
> **UpdateOptions**: `object`
3+
> **UpdateOptions** = `object`
44
55
Options to customise the behaviour of UpdateManager.
66

7-
## Type declaration
7+
## Properties
88

99
### AllowVersionDowngrade
1010

@@ -15,6 +15,8 @@ This could happen if a release has bugs and was retracted from the release feed,
1515
ExplicitChannel to switch channels to another channel where the latest version on that
1616
channel is lower than the current version.
1717

18+
***
19+
1820
### ExplicitChannel
1921

2022
> **ExplicitChannel**: `string` \| `null`

‎docs/reference/js/TypeAlias.VelopackLocatorConfig.md‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,51 @@
11
# Type Alias: VelopackLocatorConfig
22

3-
> **VelopackLocatorConfig**: `object`
3+
> **VelopackLocatorConfig** = `object`
44
55
VelopackLocator provides some utility functions for locating the current app important paths (eg. path to packages, update binary, and so forth).
66

7-
## Type declaration
7+
## Properties
88

99
### CurrentBinaryDir
1010

1111
> **CurrentBinaryDir**: `string`
1212
1313
The directory containing the application's user binaries.
1414

15+
***
16+
1517
### IsPortable
1618

1719
> **IsPortable**: `boolean`
1820
1921
Whether the current application is portable or installed.
2022

23+
***
24+
2125
### ManifestPath
2226

2327
> **ManifestPath**: `string`
2428
2529
The current app manifest.
2630

31+
***
32+
2733
### PackagesDir
2834

2935
> **PackagesDir**: `string`
3036
3137
The path to the packages' directory.
3238

39+
***
40+
3341
### RootAppDir
3442

3543
> **RootAppDir**: `string`
3644
3745
The root directory of the current app.
3846

47+
***
48+
3949
### UpdateExePath
4050

4151
> **UpdateExePath**: `string`

‎docs/reference/js/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ sidebar_position: 0
1313

1414
## Type Aliases
1515

16-
| Type alias | Description |
16+
| Type Alias | Description |
1717
| ------ | ------ |
1818
| [UpdateInfo](TypeAlias.UpdateInfo.md) | Holds information about the current version and pending updates, such as how many there are, and access to release notes. |
1919
| [UpdateOptions](TypeAlias.UpdateOptions.md) | Options to customise the behaviour of UpdateManager. |

0 commit comments

Comments
 (0)