# @devframes/plugin-data-inspector 中文文档

规范地址：https://npmcn.com/package/%40devframes/plugin-data-inspector/

版本：1\.3\.3
npm 元数据更新时间：2026-11-10T08:40:11.077Z
中文译文更新时间：2026-11-12T03:06:32.971Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40devframes/plugin-data-inspector
原文对照：https://npmcn.com/package/%40devframes/plugin-data-inspector/?lang=original
项目主页：https://github.com/devframes/devframe#readme
源码仓库：https://github.com/devframes/devframe

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

- 包体积（解压后）：279 kB，26 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：vite ^7\.0\.0 \|\| ^8\.0\.0，devframe 1\.3\.3，@devframes/plugin-data-inspector--assets 1\.3\.3
- 首次发布：2026-07-17T07:44:24.001Z
- 最新版本发布：2026-11-10T08:40:09.922Z
- 近 30 天下载量：121076（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：58（近 12 个月 58 个）

## 中文简介

用于与 jora 查询交互检查活服务器对象的 Devframe 插件 .

## 安装

```sh
npm install @devframes/plugin-data-inspector
```

也可以使用：`pnpm add @devframes/plugin-data-inspector`、`yarn add @devframes/plugin-data-inspector`、`bun add @devframes/plugin-data-inspector`

## README

# @devframes/plugin-data-检查器

交互检查服务器侧的活式对象 。 其他发展框架和主机框架登记册 **数据来源**;工作台作曲 [乔拉](https://github.com/discoveryjs/jora) (在拥有对象的进程中执行),使正常化的结果产生 [发现.js](https://github.com/discoveryjs/discovery) 以类型徽章、形状面板、保存查询和可共享的 URL 状态构建视图。 深图一次扩展一个关卡( S)`load deeper` 按要求获取每个子树,一个可选的传票人每N秒重新运行一次查询,一个工具栏提供扩展/collaps-all并复制.

## 登记数据来源

登记处 **进程全球**: 从任何地方登记,在变形板挂起之前或之后:

```ts
import { registerDataSource } from '@devframes/plugin-data-inspector/registry'

registerDataSource({
  id: 'my-plugin:state',
  title: 'My plugin state',
  description: 'The live state store',
  data: () => store, // value or (async) factory; `static: true` memoizes
  queries: [
    { title: 'Active entries', query: 'entries.mapEntries()' }
  ],
})
```

偏好零套件依赖的 Devframes 通过已键入上下文服务消耗同一商店 :

```ts
ctx.services.whenAvailable('devframes:plugin:data-inspector:sources', (sources) => {
  sources.register({
    id: 'my-plugin:state',
    title: 'My state',
    data: () => store
  })
})
```

## 可证明来源

来源选择使用 `writable: true`: 在根视图上(`$`),每个值会长出一个编辑负担,在您设置一个值(字符串 / 数字 / 布尔 / 无效 / 未定义 / JSON), 添加或删除条目, 或重命名密钥时打开一个侧面板; 变量被应用 **位于活动对象的位置** 通过 `write` RPC (中文(简体) ). 只读保留默认值; `static: true` 来源是被回忆的快照,并且总是只读(宣布两个报告) `DP_DATA_INSPECTOR_0004`) (中文(简体) ).

`registerDataSource` 返回控点; 调用 `notifyChanged()` 当数据在检查员之外更改时, 将视图重新连接运行, 或者通过 `subscribe`数字 :

```ts
const handle = registerDataSource({
  id: 'my-plugin:state',
  title: 'My plugin state',
  data: () => store,
  writable: true, // opt-in: the inspector may mutate the live object
  subscribe: (notify) => { // optional: push the source's own change signal
    store.on('change', notify)
    return () => store.off('change', notify)
  },
})

handle.notifyChanged() // or notify imperatively
```

## 挂载

```ts
// the default export is the factory; call it for an instance:
import createDataInspectorDevframe from '@devframes/plugin-data-inspector'
// Vite
import { devframeVite } from '@devframes/vite/single'

devframeVite(createDataInspectorDevframe())
```

## 独立的CLI

```sh
pnpx @devframes/plugin-data-inspector stats.json trace.jsonl # inspect local data files
pnpx @devframes/plugin-data-inspector build stats.json       # self-contained static export
pnpx @devframes/plugin-data-inspector attach                 # attach to a process running the inject entry
```

静态导出嵌入了数据集并运行相同的查询引擎客户端,因此所保存的食谱保持可移植性.

## 附加到另一个节点进程

```ts
import { exposeDataInspector } from '@devframes/plugin-data-inspector/inject'

// pass sources inline, or register them separately beforehand
await exposeDataInspector({
  sources: [
    {
      id: 'app:store',
      title: 'App store',
      data: () => store
    }
  ],
})
```

或零代码更改:

```sh
DEVFRAME_DATA_INSPECTOR=1 node --import @devframes/plugin-data-inspector/inject server.js
```

在零码路径上,没有地方可以呼叫 `registerDataSource`自动登记 a **`globalThis`** 来源:将您想要检查的内容指定到全局对象上( q)`globalThis.store = store`)和查询其活性. 选择退出 `DEVFRAME_DATA_INSPECTOR_GLOBAL=0`。 。 。 .

插入条目绑定 `127.0.0.1`,需要defraft的信任握手 与每个运行的符号默认,并广告它的终点在 `node_modules/.data-inspector/discovery.json`,哪个 `pnpx @devframes/plugin-data-inspector attach` 自动取出.

> \[尖叫声\] 一个连接的检查员对活的物体进行eval级的jora查询:查询可以引用可达到的函数作为自己的属性和取火器. 将注射端点像调试器端口一样处理:保持回回转并保持认证.

## 已保存的查询

食谱( R)`{ query, title?, description?, ...filters }`(d) 坚持以两种方式进行: **工作空间** (承诺, `getStorageDir('workspace')/data-inspector/queries.json`(与团队分享) **项目** (逐笔离职 `node_modules`) (中文(简体) ).

## 常见问题

### @devframes/plugin-data-inspector 是什么？

用于与 jora 查询交互检查活服务器对象的 Devframe 插件 \.

### 如何安装 @devframes/plugin-data-inspector？

在项目目录运行 npm install @devframes/plugin-data-inspector，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：devframe（1\.3\.3）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 devframe-data-inspector，可以用 npx devframe-data-inspector 直接运行。

### @devframes/plugin-data-inspector 支持 TypeScript 吗？

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

### @devframes/plugin-data-inspector 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @devframes/plugin-data-inspector 可以商用吗？

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

### @devframes/plugin-data-inspector 的下载量有多少？

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

### @devframes/plugin-data-inspector 还在维护吗？

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