-
-
Notifications
You must be signed in to change notification settings - Fork 535
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(plugin-local-electron): add docs for the config options
- Loading branch information
1 parent
8af9268
commit ebcd4c1
Showing
1 changed file
with
27 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,32 @@ | ||
export interface LocalElectronPluginConfig { | ||
enabled: boolean; | ||
/** | ||
* Whether or not the plugin is enabled. | ||
* | ||
* Can be handy to set this to an environment variable for quick personal | ||
* toggling of this plugin. | ||
* | ||
* Default: `true` | ||
*/ | ||
enabled?: boolean; | ||
/** | ||
* An absolute path to the folder containing your built version of Electron. | ||
* | ||
* Normally this looks like `/path/to/electron/out/D` | ||
*/ | ||
electronPath: string; | ||
/** | ||
* The platform your local build of Electron is for. You only need to set | ||
* this if you have a local build for a platform that isn't your system's | ||
* platform. | ||
* | ||
* Default: process.platform | ||
*/ | ||
electronPlatform?: string; | ||
/** | ||
* The arch your local build of Electron is for. You only need to set this if | ||
* you have a local build for an arch that isn't your system's arch. | ||
* | ||
* Default: process.arch | ||
*/ | ||
electronArch?: string; | ||
} |