shell

Gère des fichiers et URLs à l'aide de leurs applications par défaut.

Process: Main, Renderer (non-sandboxed only)

Le module shell fournit des fonctions liées à l'intégration bureau.

Un exemple d'ouverture d'une URL dans le navigateur par défaut de l'utilisateur :

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.

Méthodes

Le module shell dispose des méthodes suivantes :

shell.showItemInFolder(fullPath)

• fullPath string

Afficher le fichier donné dans un gestionnaire de fichiers. Si possible, sélectionnez le fichier.

shell.openPath(path)

• path string

Retourne Promise<string> - qui se résout avec une chaîne contenant le message d'erreur correspondant à l'échec en cas d'échec, sinon "".

Ouvre le fichier donné dans la manière par défaut de l'ordinateur.

shell.openExternal(url[, options])

• url string - Max 2081 characters on Windows.
• options Object (facultatif)
  • activate boolean (facultatif) macOS - true pour amener l'application ouverte au premier plan. Par défaut, true.
  • workingDirectory string (optional) Windows - Le dossier de travail.
  • logUsage booléen (facultatif) Windows - Indique un lancement initié par l’utilisateur qui permet de suivre les programmes fréquemment utilisés et d’autres comportements. Est à false par défaut.

Retourne Promise<void>

Ouvre l'URL du protocole externe donné de la manière par défaut du bureau. (Par exemple, mailto: URLs dans l'agent de messagerie de l'utilisateur).

shell.trashItem(path)

• path string - chemin vers l'élément à déplacer vers la corbeille.

Retourne une Promise<void> - qui se résout une fois l'opération terminée. Rejette s'il y a eu une erreur lors de la suppression de l'élément demandé.

Cela déplace un chemin vers l'emplacement de la corbeille spécifique au système d'exploitation (Trash sur macOS, RecycleBin sur Windows, et un emplacement spécifique à l'environnement sur Linux).

shell.beep()

Émet un signal sonore.

shell.writeShortcutLink(shortcutPath[, operation], options) Windows

• shortcutPath string
• operation string (facultatif) - La valeur par défaut est create, peut être l'une des valeurs suivantes:
  • create - Créer un nouveau raccourci, écrase si besoin.
  • update - Met à jour les propriétés seulement sur un raccourci existant.
  • replace - Remplace un raccourci existant, échoue si le raccourci n'existe pas.
• options ShortcutDetails

Retourne boolean - Si le raccourci a été créé avec succès.

Créer ou met à jour un lien raccourci à shortcutPath.

shell.readShortcutLink(shortcutPath) Windows

• shortcutPath string

Returns ShortcutDetails

Résout le lien raccourci à shortcutPath.

Une exception sera levée lorsqu’une erreur se produit.