跳至主要內容

netLog

記錄工作階段的網路事件。

程序:主程序

const { app, netLog } = require('electron')

app.whenReady().then(async () => {
await netLog.startLogging('/path/to/net-log')
// After some network events
const path = await netLog.stopLogging()
console.log('Net-logs written to', path)
})

請參閱 --log-net-log,以記錄應用程式生命週期中的網路事件。

注意:除非另有說明,否則所有方法都只能在 app 模組發出 ready 事件後使用。

方法

netLog.startLogging(path[, options])

  • path 字串 - 記錄網路日誌的檔案路徑。
  • options 物件 (選用)
    • captureMode 字串 (選用) - 應擷取哪些種類的資料。預設情況下,只會擷取關於請求的中繼資料。將此設定為 includeSensitive 會包含 Cookie 和驗證資料。將其設定為 everything 將會包含在 Socket 上傳輸的所有位元組。可以是 defaultincludeSensitiveeverything
    • maxFileSize 數字 (選用) - 當日誌超出此大小時,記錄會自動停止。預設為無限制。

傳回 Promise<void> - 在網路日誌開始記錄時解析。

開始將網路事件記錄到 path

netLog.stopLogging()

傳回 Promise<void> - 在網路日誌刷新到磁碟時解析。

停止記錄網路事件。如果未呼叫,則網路記錄會在應用程式結束時自動結束。

屬性

netLog.currentlyLogging 唯讀

一個 boolean 屬性,表示目前是否正在記錄網路日誌。