Regedit

Description

The Regedit module is a helping class which eases the task of installing your ProgId into the windows registry. Although you can manually call install() and uninstall() on every ProgId using this module is the preferred way

Functions

installAll(), returns: Promise

Install all previous instantiations of ProgId into the windows registry. There is no need to keep every ProgId in a data structure. The Regedit module will keep track of all instantiations of ProgId. Returns a promise whether every ProgId was successfully installed. Should be called when installing or updating the application. It is important that all instantiations of ProgId happens before calling this function, if you want them to register in the windows registry.

uninstallAll(), returns: Promise

The same as installAll() but for uninstalling. Should be called when uninstalling your application to clean up the windows registry.

squirrelStartupEvent(), returns boolean

Handle Squirrel startup event by inspecting the program parameters. Will return true if such a parameter is found in which case the application should quit as soon as possible. The function will install/uninstall every ProgId and call app.quit() when done. It is therefore adequate to stop further initialization of your app when true is returned from this function. When used it should be handled as early in the program as possible. Remember that instantiations of ProgId should happen before you call this function.