Skip to content
Permalink
Browse files

docs(plugin-local-electron): add docs for the config options

  • Loading branch information
MarshallOfSound committed May 3, 2018
1 parent 8af9268 commit ebcd4c13d020d30a60b7d847ec65ee9284e91c32
Showing with 27 additions and 1 deletion.
  1. +27 −1 packages/plugin/local-electron/src/Config.ts
@@ -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;
}

0 comments on commit ebcd4c1

Please sign in to comment.
You can’t perform that action at this time.