shell (fable-electron-docs-api)

shell Type

Namespace: Fable.Electron
Assembly: Fable.Electron.dll
Parent Module: Main
Base Type: obj

⚠ Process Availability: Main ✔ | Renderer ✔ | Utility ❌ | Exported ✔

Manage files and URLs using their default applications.Process: Main, Renderer (non-sandboxed only)The shell module provides functions related to desktop integration.An example of opening a URL in the user's default browser:const { shell } = require('electron')shell.openExternal('https://github.com')> [!WARNING] While the shell module can be used in the renderer process, it will not function in a sandboxed renderer.

Static members

Static member	Description
`shell.beep ()` Full Usage: `shell.beep ()` Modifiers: inline	Play the beep sound.
`shell.openExternal (url, ?activate, ?workingDirectory, ?logUsage)` Full Usage: `shell.openExternal (url, ?activate, ?workingDirectory, ?logUsage)` Parameters: url : `string` ?activate : `bool` ?workingDirectory : `string` ?logUsage : `bool` Returns: `Promise<unit>` Modifiers: inline	Open the given external protocol URL in the desktop's default manner. (For example, mailto: URLs in the user's default mail agent). url : `string` ?activate : `bool` ?workingDirectory : `string` ?logUsage : `bool` Returns: `Promise<unit>`
`shell.openPath path` Full Usage: `shell.openPath path` Parameters: path : `string` Returns: `Promise<string>` Modifiers: inline	Resolves with a string containing the error message corresponding to the failure if a failure occurred, otherwise "".Open the given file in the desktop's default manner. path : `string` Returns: `Promise<string>`
`shell.readShortcutLink shortcutPath` Full Usage: `shell.readShortcutLink shortcutPath` Parameters: shortcutPath : `string` Returns: `ShortcutDetails` Modifiers: inline	⚠ OS Compatibility: WIN ✔ \| MAC ❌ \| LIN ❌ \| MAS ❌ Resolves the shortcut link at shortcutPath.An exception will be thrown when any error happens. shortcutPath : `string` Returns: `ShortcutDetails`
`shell.showItemInFolder fullPath` Full Usage: `shell.showItemInFolder fullPath` Parameters: fullPath : `string` Modifiers: inline	Show the given file in a file manager. If possible, select the file. fullPath : `string`
`shell.trashItem path` Full Usage: `shell.trashItem path` Parameters: path : `string` Returns: `Promise<unit>` Modifiers: inline	Resolves when the operation has been completed. Rejects if there was an error while deleting the requested item.This moves a path to the OS-specific trash location (Trash on macOS, Recycle Bin on Windows, and a desktop-environment-specific location on Linux). path : `string` Returns: `Promise<unit>`
`shell.writeShortcutLink (shortcutPath, ?operation, ?options)` Full Usage: `shell.writeShortcutLink (shortcutPath, ?operation, ?options)` Parameters: shortcutPath : `string` ?operation : `Operation` ?options : `ShortcutDetails` Returns: `bool` Modifiers: inline	⚠ OS Compatibility: WIN ✔ \| MAC ❌ \| LIN ❌ \| MAS ❌ Whether the shortcut was created successfully.Creates or updates a shortcut link at shortcutPath. shortcutPath : `string` ?operation : `Operation` ?options : `ShortcutDetails` Returns: `bool`