kalugin66/webtorrent-desktop
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add comments to squirrel-win32.js

Browse Source
This commit is contained in:
Feross Aboukhadijeh
2016-05-30 02:16:12 -07:00
parent 1b8f180255
commit bd358b7692
1 changed files with 22 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
main/squirrel-win32.js
View File

@@ -61,15 +61,17 @@ function handleEvent (cmd) {
} }
if (cmd === '--squirrel-firstrun') { if (cmd === '--squirrel-firstrun') {
// This is called on the app's first run. Do not quit, allow startup to continue. // App is running for the first time. Do not quit, allow startup to continue.
return false return false
} }
return false return false
} }
// Spawn a command and invoke the callback when it completes with an error and the output /**
// from standard out. * Spawn a command and invoke the callback when it completes with an error and
* the output from standard out.
*/
function spawn (command, args, cb) { function spawn (command, args, cb) {
var stdout = '' var stdout = ''
@@ -99,24 +101,31 @@ function spawn (command, args, cb) {
}) })
} }
// Spawn Squirrel's Update.exe with the given arguments and invoke the callback when the /**
// command completes. * Spawn the Squirrel `Update.exe` command with the given arguments and invoke
* the callback when the command completes.
*/
function spawnUpdate (args, cb) { function spawnUpdate (args, cb) {
spawn(UPDATE_EXE, args, cb) spawn(UPDATE_EXE, args, cb)
} }
// Create desktop/start menu shortcuts using the Squirrel Update.exe command line API /**
* Create desktop and start menu shortcuts using the Squirrel `Update.exe`
* command.
*/
function createShortcuts (cb) { function createShortcuts (cb) {
spawnUpdate(['--createShortcut', EXE_NAME], cb) spawnUpdate(['--createShortcut', EXE_NAME], cb)
} }
// Update desktop/start menu shortcuts using the Squirrel Update.exe command line API /**
* Update desktop and start menu shortcuts using the Squirrel `Update.exe`
* command.
*/
function updateShortcuts (cb) { function updateShortcuts (cb) {
var homeDir = os.homedir() var homeDir = os.homedir()
if (homeDir) { if (homeDir) {
var desktopShortcutPath = path.join(homeDir, 'Desktop', 'WebTorrent.lnk') var desktopShortcutPath = path.join(homeDir, 'Desktop', 'WebTorrent.lnk')
// Check if the desktop shortcut has been previously deleted and and keep it deleted // If the desktop shortcut was deleted by the user, then keep it deleted.
// if it was
fs.access(desktopShortcutPath, function (err) { fs.access(desktopShortcutPath, function (err) {
var desktopShortcutExists = !err var desktopShortcutExists = !err
createShortcuts(function () { createShortcuts(function () {
@@ -133,7 +142,10 @@ function updateShortcuts (cb) {
} }
} }
// Remove desktop/start menu shortcuts using the Squirrel Update.exe command line API /**
* Remove desktop and start menu shortcuts using the Squirrel `Update.exe`
* command.
*/
function removeShortcuts (cb) { function removeShortcuts (cb) {
spawnUpdate(['--removeShortcut', EXE_NAME], cb) spawnUpdate(['--removeShortcut', EXE_NAME], cb)
} }