类: Debugger

类: Debugger

Chrome 远程调试协议的替代传输方式。

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

Chrome 开发者工具在 JavaScript 运行时有一个特殊绑定，允许与页面交互并对其进行检测。

const { BrowserWindow } = require('electron')
const win = new BrowserWindow()

try {
  win.webContents.debugger.attach('1.1')
} catch (err) {
  console.log('Debugger attach failed : ', err)
}

win.webContents.debugger.on('detach', (event, reason) => {
  console.log('Debugger detached due to : ', reason)
})

win.webContents.debugger.on('message', (event, method, params) => {
  if (method === 'Network.requestWillBeSent') {
    if (params.request.url === 'https://www.github.com') {
      win.webContents.debugger.detach()
    }
  }
})

win.webContents.debugger.sendCommand('Network.enable')

实例事件

事件: 'detach'

返回值

• event 事件
• reason 字符串 - 分离调试器的原因。

当调试会话终止时发出。这会在 webContents 关闭或为附加的 webContents 调用 devtools 时发生。

事件: 'message'

返回值

• event 事件
• method 字符串 - 方法名。
• params any - 远程调试协议中“parameters”属性定义的事件参数。
• sessionId 字符串 - 附加调试会话的唯一标识符，将与从 debugger.sendCommand 发送的值匹配。

每当调试目标发出检测事件时发出。

实例方法

debugger.attach([protocolVersion])

• protocolVersion 字符串 (可选) - 请求的调试协议版本。

将调试器附加到 webContents。

debugger.isAttached()

返回值 boolean - 调试器是否附加到 webContents。

debugger.detach()

从 webContents 分离调试器。

debugger.sendCommand(method[, commandParams, sessionId])

• method 字符串 - 方法名，应为 远程调试协议定义的方法之一。
• commandParams any (可选) - 包含请求参数的 JSON 对象。
• sessionId 字符串 (可选) - 将命令发送到具有关联调试会话 ID 的目标。初始值可以通过发送 Target.attachToTarget 消息获得。

返回值 Promise<any> - 一个 Promise，它使用远程调试协议中命令描述的“returns”属性定义的响应来解决，或者被拒绝，表明命令失败。

将给定命令发送到调试目标。