diff --git a/docs/api/shell.md b/docs/api/shell.md index f0848875a975..662fa588f3f0 100644 --- a/docs/api/shell.md +++ b/docs/api/shell.md @@ -2,38 +2,43 @@ The `shell` module provides functions related to desktop integration. -An example of opening a URL in default browser: +An example of opening a URL in the user's default browser: ```javascript var shell = require('shell'); + shell.openExternal('https://github.com'); ``` -## shell.showItemInFolder(fullPath) +## 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) +### `shell.openItem(fullPath)` * `fullPath` String Open the given file in the desktop's default manner. -## shell.openExternal(url) +### `shell.openExternal(url)` * `url` String Open the given external protocol URL in the desktop's default manner. (For -example, mailto: URLs in the default mail user agent.) +example, mailto: URLs in the user's default mail agent.) -## shell.moveItemToTrash(fullPath) +### `shell.moveItemToTrash(fullPath)` * `fullPath` String -Move the given file to trash and returns boolean status for the operation. +Move the given file to trash and returns a boolean status for the operation. -## shell.beep() +### `shell.beep()` Play the beep sound.