mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
electron/docs/api/shell.md
Jessica Lord a2cc936a3b Standardize shell
2015-08-28 22:28:30 -07:00

888 B
Raw Blame History

shell

The shell module provides functions related to desktop integration.

An example of opening a URL in the user's default browser:

var shell = require('shell');

shell.openExternal('https://github.com');

Methods

The shell module has the following methods:

shell.showItemInFolder(fullPath)

  • fullPath String

Show the given file in a file manager. If possible, select the file.

shell.openItem(fullPath)

  • fullPath String

Open the given file in the desktop's default manner.

shell.openExternal(url)

  • url String

Open the given external protocol URL in the desktop's default manner. (For example, mailto: URLs in the user's default mail agent.)

shell.moveItemToTrash(fullPath)

  • fullPath String

Move the given file to trash and returns a boolean status for the operation.

shell.beep()

Play the beep sound.