@graphql-markdown/graphql

中文文档
1.3.5发布于 2026/11/15MITTypeScriptESM + CJS构建来源已验证近 30 天下载 9.9万

GraphQL schema loading, introspection and type utilities for GraphQL-Markdown.

原始使用文档
文档目录7 节
  1. Installation
  2. Usage
  3. Loading a schema
  4. Introspecting a schema
  5. Filtering types with decorator predicates
  6. Documentation
  7. License

@graphql-markdown/graphql

Latest Version JSR GitHub License Technical Debt Coverage Mutation Score

Low-level GraphQL schema utilities used by GraphQL-Markdown: schema loading, introspection, directive resolution, and the decorator predicates used to filter and group schema types. This package is a building block for @graphql-markdown/core and @graphql-markdown/printer-legacy; most users should not need to depend on it directly.

Installation

npm install @graphql-markdown/graphql

Usage

Loading a schema

import { GraphQLFileLoader } from "@graphql-tools/graphql-file-loader";
import { loadSchema } from "@graphql-markdown/graphql";

const schema = await loadSchema("./schema.graphql", {
  loaders: [new GraphQLFileLoader()],
});

Introspecting a schema

import { getSchemaMap } from "@graphql-markdown/graphql";

const schemaMap = getSchemaMap(schema);

Filtering types with decorator predicates

import { and, hasDirectiveNamed, isEntity } from "@graphql-markdown/graphql";

const isDeprecatedObject = and(
  isEntity("objects"),
  hasDirectiveNamed("deprecated"),
);

Documentation

License

GraphQL-Markdown packages are 100% free and open-source, under the MIT license.

This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest, you'll be creating employment for local families and restoring wildlife habitats.

版本与发布记录

@graphql-markdown/graphql 共发布 26 个版本,首次发布于 2023/08/21;过去 12 个月发布了 12 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.3.5latest2026/11/151 天前
1.3.42026/10/3018 天前
1.3.32026/10/131 个月前
1.3.22026/10/101 个月前
1.3.12026/10/091 个月前
1.3.02026/09/181 个月前

关于 @graphql-markdown/graphql 的常见问题

@graphql-markdown/graphql 是什么?

GraphQL schema loading, introspection and type utilities for GraphQL-Markdown.

如何安装 @graphql-markdown/graphql?

在项目目录运行 npm install @graphql-markdown/graphql,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:graphql(^16.0.0 || ^17.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@graphql-markdown/graphql 支持 TypeScript 吗?

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

@graphql-markdown/graphql 支持 ESM 还是 CommonJS?

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

@graphql-markdown/graphql 需要什么版本的 Node.js?

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

@graphql-markdown/graphql 可以商用吗?

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

@graphql-markdown/graphql 的下载量有多少?

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

@graphql-markdown/graphql 还在维护吗?

最新版本 1.3.5 发布于 2026/11/15(1 天前);至今共发布 26 个版本,其中过去 12 个月发布了 12 个;首次发布于 2023/08/21。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。