Package Exports

electron-regedit

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (electron-regedit) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

electron-regedit

File associations, file icons & open with... for electron apps

This module allow you to register your app in the windows registry, manipulate context menus & handle native open, edit, print, preview actions ect.

Installation

npm install electron-regedit

Documentation

Toy Example

As a short documentation, here is how the module is used:

const {ProgId, ShellOption, Regedit} = require('electron-regedit')

new ProgId({
    appName: 'My App',
    description: 'My App File',
    friendlyAppName: 'My App Alias',
    icon: 'myicon.ico',
    extensions: ['myapp'],
    shell: [
        new ShellOption({verb: ShellOption.OPEN}),
        new ShellOption({verb: ShellOption.EDIT, args: ['--edit']}),
        new ShellOption({verb: ShellOption.PRINT, args: ['--print']})
    ]
})

Regedit.installAll()

Squirrel integration

You will need to call Regedit.installAll() and Regedit.uninstallAll() when installing/uninstalling your application to clean up the registry. If you are using Squirrel there is a helping function to handle this. It is very important that all instantions of new ProgId({...}) have been done before handling Squirrel events or installing/uninstalling into the registry.

const {Regedit} = require('electron-regedit')

//... instantiate your ProgIds

if (Regedit.squirrelStartupEvent()) return

//... the rest of your application code