# @electron/devtron 中文文档

规范地址：https://npmcn.com/package/%40electron/devtron/

版本：2\.1\.1
npm 元数据更新时间：2025-11-18T07:07:53.220Z
中文译文更新时间：2026-11-13T12:13:45.422Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40electron/devtron
原文对照：https://npmcn.com/package/%40electron/devtron/?lang=original
项目主页：https://github.com/electron/devtron
源码仓库：https://github.com/electron/devtron

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：1.7 MB，45 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.12\.0
- 运行依赖：9 个
- 首次发布：2025-09-04T00:26:43.348Z
- 最新版本发布：2025-11-18T07:07:52.806Z
- 近 30 天下载量：4106（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 1 个）

## 中文简介

电子 DevTools 扩展以跟踪 IPC 事件

## 安装

```sh
npm install @electron/devtron
```

也可以使用：`pnpm add @electron/devtron`、`yarn add @electron/devtron`、`bun add @electron/devtron`

## README

# ![Devtron icon](https://cloud.githubusercontent.com/assets/378023/15063285/cf554e40-1383-11e6-9b9c-45d381b03f9f.png) 德弗龙

[![Test](https://github.com/electron/devtron/actions/workflows/test.yml/badge.svg)](https://github.com/electron/devtron/actions/workflows/test.yml) [![npm version](http://img.shields.io/npm/v/@electron/devtron.svg)](https://npmjs.org/package/@electron/devtron)

> \[注\] 该项目正在拟订之中,可能会有所改变.

## 建设与发展

这个项目使用 [第4号](https://yarnpkg.com/) 管理依赖关系.

要开始 :

-   把仓库切入本地机器
-   运行 `yarn install` 以安装依赖关系
-   运行 `yarn build` 建设项目

### 配置使用 Devtron 的 Electron App

-   在您 Electron app的主要入口处,添加以下代码来加载 Devtron :

```js
// main.js
const { devtron } = require('@electron/devtron');
// or import { devtron } from '@electron/devtron'

devtron.install(); // call this function at the top of your file
```

-   Devtron 可有条件安装在 **开发模式** 避免影响生产建设。 举个例子:

```js
const { app } = require('electron');

const isDev = !app.isPackaged;

async function installDevtron() {
  const { devtron } = await import('@electron/devtron');
  await devtron.install();
}

if (isDev) {
  installDevtron().catch((error) => {
    console.error('Failed to install Devtron:', error);
  });
}
```

## 德弗特龙 API

### `await devtron.install(options)`

将 Devtron 安装到 Electron 应用程序中 [配置使用 Devtron 的 Electron App](https://npmcn.com/package/%40electron/devtron/#readme-configuring-an-electron-app-to-use-devtron) 用于安装指令.

#### `Options`

| 选项 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| `logLevel` | `'debug' | 'info' | 'warn' | 'error' | 'none'` | `'warn'` | 为日志设定最小日志级别 。 此级别以下的信件被忽略 .  
  
**级别 :**  
二. 支助 `debug` ——日志:调试,信息,警告,出错  
二. 支助 `info` ——日志:信息、警告、错误  
二. 支助 `warn` ——日志:警告,错误  
二. 支助 `error` —日志:仅出错  
二. 支助 `none` ——禁用所有日志 |

实例:

```js
// Only 'warn' and 'error' logs will appear in the terminal
await devtron.install({ logLevel: 'warn' });
```

### `await devtron.getEvents()`

回返a **答应** 解决了Devtron服务人员自安装以来记录的一系列IPC事件.

-   如果 `Clear all events` 按钮.
    
-   如果阵列大小超过20,000个事件,则会被缩短到最近的20,000个事件.
    
-   如果在安装之前或Devtron服务工人准备就绪之前呼叫,则会返回一个空阵列.
    

以下是一个用法例子,它使IPC事件每2秒记录一次:

```js
// main.js
import { devtron } from '@electron/devtron';

// Ensure Devtron is installed before calling getEvents()
devtron.install();

setInterval(async () => {
  const ipcEvents = await devtron.getEvents();
  console.log('IPC Events:', ipcEvents);
}, 2000);
```

## 要求和限制

-   电子版本必须是36.0.0或更高.
-   Devtron 与新创建的合作 **会议**你必须打电话 `devtron.install()` 在他们被创造之前.
-   Electron应用软件启动后立即发送的一些IPC事件可能不会被德夫特龙抓住,即使 `devtron.install()` 因为Devtron在开始应用后可能需要很短的时间才能初始化.
-   `ipcRenderer.once` 将作为两个不同的活动跟踪: `ipcRenderer.on` 财务报告和审定财务报表 `ipcRenderer.removeListener`。 。 。 .

如果 Devtron 安装正确, 它应该作为标签出现在您的电子应用程序的开发者工具中 .

![](https://github.com/user-attachments/assets/0f278b54-50fe-4116-9317-9c1525bf872b)

## 常见问题

### @electron/devtron 是什么？

电子 DevTools 扩展以跟踪 IPC 事件

### 如何安装 @electron/devtron？

在项目目录运行 npm install @electron/devtron，或使用 pnpm add / yarn add / bun add。

### @electron/devtron 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @electron/devtron 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @electron/devtron 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.12\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @electron/devtron 可以商用吗？

@electron/devtron 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @electron/devtron 的下载量有多少？

根据 npm 官方下载统计，@electron/devtron 在 2026/10/14 – 2026/11/12 这 30 天内被下载 4,106 次，日均约 137 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @electron/devtron 还在维护吗？

最新版本 2\.1\.1 发布于 2025/11/18（11 个月前）；至今共发布 4 个版本，其中过去 12 个月发布了 1 个；首次发布于 2025/09/04。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。