#快速开始

本包为 MediaWiki API 响应的类型声明，针对 formatversion=2、字段并集覆盖 1.39–1.47。包只含类型定义（dist/*.d.ts），没有任何运行时代码，不增加构建产物体积。

npm install -D types-mediawiki-response

yarn add -D types-mediawiki-response

pnpm add -D types-mediawiki-response

bun add -d types-mediawiki-response

deno add npm:types-mediawiki-response

import type { ApiQueryResponse } from "types-mediawiki-response";

const res = (await api.get({
  action: "query",
  prop: "revisions",
  titles,
  formatversion: "2",
})) as ApiQueryResponse;

console.log(res.query.pages[0]?.revisions);

#处理响应报错

as ApiXxxResponse 只断根处没有 error，不等于“操作成功”。处理响应报错主要根据客户端类型决定：

• 自动处理根下错误的客户端如 mw.Api，响应带根级 error / errors 会直接抛出异常，直接用 try-catch 包住请求即可，无需额外处理响应类型。
• 未经处理、把错误结果原样返回的客户端（比如原生 fetch），需要用 ApiResponseWith<T> 包一层、按 error / errors 收窄。

具体处理见信封与错误处理。

#扩展

核心类型只覆盖 MediaWiki 核心模块。扩展贡献的字段拆成了按需启用的包：在项目中任意被 tsconfig 包含的文件里写一条 type-only import，其提供的字段就会全局生效：

// 激活用户查核扩展
import type {} from "types-mediawiki-response/ext/checkuser";

真实响应里有、核心类型上找不到的字段多半来自扩展，这就是去激活对应包的信号。

扩展的 action（action=thank、action=shortenurl 等）不并入共享形状，而是各自导出独立的响应类型，像核心 action 一样在调用处按名导入使用：

import type { ApiThankResponse } from "types-mediawiki-response/ext/thanks";

const res: ApiThankResponse = await api.post({ action: "thank", rev });
res.result?.recipient; // 被感谢的用户

见按需启用扩展包。

#与 AI 协作

本文档站除了各页顶部的复制 Markdown 等功能，还有同步发布 llms.txt：

• llms.txt：索引文件，包含文档站各页面的说明和链接

  https://types-mediawiki-response.pages.dev/zh/llms.txt
• llms-full.txt：合并有本文档站所有内容

  https://types-mediawiki-response.pages.dev/zh/llms-full.txt

可以视使用需要将链接复制给你的 agent。

#下一步

• 信封与错误处理
• query 响应
• 字段约定
• 按需启用扩展包
• 示例