81795744cf
* fix: ensure the typescript definitions only export correct value types In typescript there are two main types of "types" you can export, value types (class, const) and definition types (type, interface). The typescript compiler will let anything declared via const or class be used as a value. Unfortunately we were exporting a bunch of things (see the diff) as class/const when they weren't actually exported values. This lead to typescript being happy but the runtime throwing errors (not something we want). This change passes "exported-in" context through our docs, to the parser and then to the definitions generator to ensure we only mark things as exported in the ts defs that we actually export. Fixes #22167 * chore: update typescript-defs * chore: update typescript-defs * chore: fix bad typescript in IPC test * docs: test rendering of new syntax * chore: update per feedback, use same syntax but with 'this is not exportedd' line
1.8 KiB
Class: CommandLine
Manipulate the command line arguments for your app that Chromium reads
Process: Main
This class is not exported from the 'electron' module. It is only available as a return value of other methods in the Electron API.
The following example shows how to check if the --disable-gpu flag is set.
const { app } = require('electron')
app.commandLine.hasSwitch('disable-gpu')
For more information on what kinds of flags and switches you can use, check out the Command Line Switches document.
Instance Methods
commandLine.appendSwitch(switch[, value])
switchString - A command-line switch, without the leading--valueString (optional) - A value for the given switch
Append a switch (with optional value) to Chromium's command line.
Note: This will not affect process.argv. The intended usage of this function is to
control Chromium's behavior.
commandLine.appendArgument(value)
valueString - The argument to append to the command line
Append an argument to Chromium's command line. The argument will be quoted correctly. Switches will precede arguments regardless of appending order.
If you're appending an argument like --switch=value, consider using appendSwitch('switch', 'value') instead.
Note: This will not affect process.argv. The intended usage of this function is to
control Chromium's behavior.
commandLine.hasSwitch(switch)
switchString - A command-line switch
Returns Boolean - Whether the command-line switch is present.
commandLine.getSwitchValue(switch)
switchString - A command-line switch
Returns String - The command-line switch value.
Note: When the switch is not present or has no value, it returns empty string.