getting-started/electron

[giscus[bot]]

getting-started/electron

Get started with our NPM package for JS & Electron.

https://docs.velopack.io/getting-started/electron

[maninder-aapnainfotech]

There are few mistakes in electron page documentation. May be, code would have changed after updating this doc.

1. let updateInfo = await updateManager.checkForUpdatesAsync(); returns :
   UpdateInfo {
   isDowngrade: false,
   targetFullRelease: VelopackAsset {
   packageId: '',
   version: '1.2.3',
   type: 1,
   fileName: 'MeraMonitor-1.2.3-full.nupkg',
   sha1: 'CED8A47C81907673BF062C1F62AB8BD3946EDD61',
   size: 211136706n,
   notesMarkdown: '',
   notesHTML: ''
   }
   }

when you are downloading updates you will need to pass updateInfo.targetFullRelease instead of updateInfo :

await updateManager.downloadUpdatesAsync(updateInfo.targetFullRelease);

2. downloadUpdateAsync is incorrect method. correct one is :
   await updateManager.downloadUpdatesAsync(updateInfo.targetFullRelease);
   documentation says :
   await window.velopackApi.downloadUpdates(updateInfo);
3. waitExitThenApplyUpdate is incorrect method. correct one is :
   await updateManager.waitExitThenApplyUpdates(updateInfo.targetFullRelease);
   documentation says :
   await updateManager.waitExitThenApplyUpdates(updateInfo);

[caesay]

I believe the documentation is correct, the code has been copied from our Electron Sample App. Please make sure you update to the latest version of the velopack npm package and if you have any other issues please open an issue on GitHub or Discord.