# @appium/typedoc-plugin-appium 中文文档

规范地址：https://npmcn.com/package/%40appium/typedoc-plugin-appium/

版本：0\.6\.6
npm 元数据更新时间：2026-10-08T09:04:13.885Z
中文译文更新时间：2026-11-06T11:33:16.011Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：471 kB，196 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：^14\.17\.0 \|\| ^16\.13\.0 \|\| \>=18\.0\.0
- 运行依赖：4 个
- peer 依赖：appium ^2\.0\.0-beta\.48，typedoc ~0\.23\.14，typescript ^4\.7\.0 \|\| ^5\.0\.0，typedoc-plugin-markdown 3\.14\.0，typedoc-plugin-resolve-crossmodule-references ~0\.3\.3
- 首次发布：2022-12-14T00:10:23.213Z
- 最新版本发布：2023-08-17T20:50:38.974Z
- 近 30 天下载量：51089（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：19（近 12 个月 0 个）

## 中文简介

Appium 及其扩展的 TypeDoc 插件

## 安装

```sh
npm install @appium/typedoc-plugin-appium
```

也可以使用：`pnpm add @appium/typedoc-plugin-appium`、`yarn add @appium/typedoc-plugin-appium`、`bun add @appium/typedoc-plugin-appium`

## README

# `@appium/typedoc-plugin-appium`

> 类型文件插件 [辅料](https://appium.io/) 其扩展( h)

## 概览

此套件的杠杆 [类型文件](https://typedoc.org/) 为 Appium v2+ 驱动器和插件生成命令文档(HTTP端点、有效载荷信息等).

## 重要说明

_如果您是 Appium 扩展作者并只想构建 HTML 文档_, (中文(简体) ), **不要直接安装这个**\--而不是,安装 [`@appium/docutils`](https://github.com/appium/appium/tree/master/packages/docutils),这是一个为您配置一切的更高级的软件包.

狦 _仅限_ 要为您的扩展构建标记下的文件, 您可以直接使用此软件包 .

## 安装

`npm` v8+需要安装此软件包.

```bash
npm install @appium/typedoc-plugin-appium --save-dev
```

上述命令会安装插件以及所有必要的对等关系依赖。 见 [`package.json`](https://github.com/appium/appium/blob/master/packages/docutils/package.json) 用于完整依赖列表.

## 使用量

类型 Doc 通过一个 `typedoc.json` 或者说 `typedoc.js` 文件( 编号[读取文件](https://typedoc.org/guides/options/) 更多信息).

一个 Appium 扩展作者希望为扩展生成标记下文档,需要创建 `typedoc.json`. 至少应包括:

```json
{
  "entryPointStrategy": "packages",
  "entryPoints": ["."],
  "name": "<name of extension>",
  "theme": "appium",
  "out": "<path to output directory>"
}
```

此文件一旦创建, 您可以运行 `typedoc` 生成文档,并将输出到 `out` 上面配置的目录.

## 选项

此插件支持来自 [类型doc- 插件- 标记下](https://npm.im/typedoc-plugin-markdown),以及以下内容:

### `outputModules`

`boolean` - 除了命令文档之外,输出模块、类、接口和其他类型的信息(通常的TypeDoc输出)。 这对各种类型的完整记录是必要的. _默认值 : `true`_

### `outputBuiltinCommands`

`boolean` - 产出 _全部_ 命令和类型来自 Appium 内建 - 不只是您的扩展 。 其用意为Appium本身. _默认值 : `false`_

### `packageTitles`

`Array<{name: string, title: string}>`: 含有模块名称的对象阵列 `name` 显示名称 `title`。默认情况下,标题使用模块名称;使用此名称来推翻该行为. _默认值 : `undefined`_

### `commandsDir`

`string` - “命令”目录相对于类型Doc输出目录的名称(`out`) (中文(简体) ). _默认值 : `commands`_

### `forceBreadcrumbs`

`boolean` - 强迫面包屑输出 `hideBreadcrumbs` 从 `typedoc-plugin-markdown`。 。 。 . _默认值 : `false`_

## 发展

这个软件包使用快照测试来断言生成的平分值是正确的. 如果您做了影响插件输出的修改, 您需要更新快照 .

要更新快照, 执行 :

```bash
UPDATE_SNAPSHOT=1 npm run test:e2e
```

这将( 可能) 修改您工作副本中的快照, 因此您需要执行 .

## 许可证

版权所有 2022 OpenJS 基金会. 许可的 Apache-2.0

## 常见问题

### @appium/typedoc-plugin-appium 是什么？

Appium 及其扩展的 TypeDoc 插件

### 如何安装 @appium/typedoc-plugin-appium？

在项目目录运行 npm install @appium/typedoc-plugin-appium，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：appium（^2\.0\.0-beta\.48）、typedoc（~0\.23\.14）、typescript（^4\.7\.0 \|\| ^5\.0\.0）、typedoc-plugin-markdown（3\.14\.0）、typedoc-plugin-resolve-crossmodule-references（~0\.3\.3）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @appium/typedoc-plugin-appium 支持 TypeScript 吗？

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

### @appium/typedoc-plugin-appium 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @appium/typedoc-plugin-appium 需要什么版本的 Node\.js？

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

### @appium/typedoc-plugin-appium 可以商用吗？

@appium/typedoc-plugin-appium 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @appium/typedoc-plugin-appium 的下载量有多少？

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

### @appium/typedoc-plugin-appium 还在维护吗？

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