跳转到主要内容

类:CommandLine

类:CommandLine

操作 Chromium 读取的应用命令行参数。

进程:主进程
此类未从 'electron' 模块导出。它仅作为 Electron API 中其他方法的返回值可用。

以下示例展示了如何检查是否设置了 --disable-gpu 标志。

const { app } = require('electron')

app.commandLine.hasSwitch('disable-gpu')

有关您可以使用哪些标志和开关的更多信息,请参阅 命令行开关 文档。

实例方法

commandLine.appendSwitch(switch[, value])

  • switch string - 命令行开关,不含前导 --
  • value string (可选) - 指定开关的值。

将(可选带有 value 的)开关追加到 Chromium 的命令行。

注意

这不会影响 process.argv。此函数 intended 用途是控制 Chromium 的行为。

const { app } = require('electron')

app.commandLine.appendSwitch('remote-debugging-port', '8315')

commandLine.appendArgument(value)

  • value string - 要追加到命令行的参数。

将参数追加到 Chromium 的命令行。参数将被正确引用。开关将优先于参数,无论追加顺序如何。

如果您要追加类似 --switch=value 的参数,请考虑改用 appendSwitch('switch', 'value')

const { app } = require('electron')

app.commandLine.appendArgument('--enable-experimental-web-platform-features')
注意

这不会影响 process.argv。此函数 intended 用途是控制 Chromium 的行为。

commandLine.hasSwitch(switch)

  • switch string - 命令行开关。

返回 boolean - 命令行开关是否存在。

const { app } = require('electron')

app.commandLine.appendSwitch('remote-debugging-port', '8315')
const hasPort = app.commandLine.hasSwitch('remote-debugging-port')
console.log(hasPort) // true

commandLine.getSwitchValue(switch)

  • switch string - 命令行开关。

返回 string - 命令行开关的值。

此函数用于获取 Chromium 命令行开关。它不应用于特定于应用程序的命令行参数。后者请使用 process.argv

const { app } = require('electron')

app.commandLine.appendSwitch('remote-debugging-port', '8315')
const portValue = app.commandLine.getSwitchValue('remote-debugging-port')
console.log(portValue) // '8315'
注意

当开关不存在或没有值时,将返回空字符串。

commandLine.removeSwitch(switch)

  • switch string - 命令行开关。

从 Chromium 的命令行中删除指定的开关。

const { app } = require('electron')

app.commandLine.appendSwitch('remote-debugging-port', '8315')
console.log(app.commandLine.hasSwitch('remote-debugging-port')) // true

app.commandLine.removeSwitch('remote-debugging-port')
console.log(app.commandLine.hasSwitch('remote-debugging-port')) // false
注意

这不会影响 process.argv。此函数 intended 用途是控制 Chromium 的行为。