# @debugr/graphql-common 中文文档

规范地址：https://npmcn.com/package/%40debugr/graphql-common/

版本：4\.0\.2
npm 元数据更新时间：2026-08-31T16:40:16.965Z
中文译文更新时间：2026-11-11T18:57:53.346Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：6.5 kB，13 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：1 个
- 首次发布：2022-08-02T09:46:36.574Z
- 最新版本发布：2026-08-31T16:40:16.684Z
- 近 30 天下载量：9099（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 3 个）

## 中文简介

GraphQL 插件的共同接口和工具功能

## 安装

```sh
npm install @debugr/graphql-common
```

也可以使用：`pnpm add @debugr/graphql-common`、`yarn add @debugr/graphql-common`、`bun add @debugr/graphql-common`

## README

# 通用图QL接口和公用设施

此软件包定义了 `data` 包含在条目中 代表 GraphQL 查询。 生成或消耗此类条目的插件 应该符合这个形状。 除非你正在开发调试器插件 或日志处理器,你通常不需要担心 这个包,因为它会 在需要时自动安装和使用.

## 用于插件开发者

该套件输出以下类型定义:

```typescript
export interface GraphqlQueryData {
  query: string; // the complete GraphQL query as a string
  variables?: Record<string, any>; // any variables passed along with the request
  operation?: string; // the extracted operation name, e.g. 'query getAllUsers'
}

export interface GraphqlQueryLogEntry<
  TTaskContext extends TContextBase = TContextBase,
  TGlobalContext extends TContextShape = TContextShape,
> extends LogEntry<TTaskContext, TGlobalContext> {
  type: 'graphql.query';
  data: GraphqlQueryData;
}
```

还有一个功能叫做 `getGraphqlOperation()` 尝试 从中提取 GraphQL 操作 `GraphqlQueryData` 对象,或者 返回时 `operation` 属性,如果它是非空的,或者通过提取启动 到第一个 `{` 字符键.

## 常见问题

### @debugr/graphql-common 是什么？

GraphQL 插件的共同接口和工具功能

### 如何安装 @debugr/graphql-common？

在项目目录运行 npm install @debugr/graphql-common，或使用 pnpm add / yarn add / bun add。

### @debugr/graphql-common 支持 TypeScript 吗？

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

### @debugr/graphql-common 支持 ESM 还是 CommonJS？

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

### @debugr/graphql-common 需要什么版本的 Node\.js？

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

### @debugr/graphql-common 可以商用吗？

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

### @debugr/graphql-common 的下载量有多少？

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

### @debugr/graphql-common 还在维护吗？

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