# @element-hq/element-web-module-api 中文文档

规范地址：https://npmcn.com/package/%40element-hq/element-web-module-api/

版本：2\.5\.0
npm 元数据更新时间：2026-11-12T13:39:13.098Z
中文译文更新时间：2026-11-13T12:03:13.370Z
软件包许可：SEE LICENSE IN README\.md

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

原始 npm 页面：https://www.npmjs.com/package/%40element-hq/element-web-module-api
原文对照：https://npmcn.com/package/%40element-hq/element-web-module-api/?lang=original
源码仓库：https://github.com/element-hq/element-web

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

- 包体积（解压后）：517 kB，12 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：0 个
- peer 依赖：react ^19，@types/react \*，matrix-web-i18n \*，@types/react-dom \*，matrix-widget-api \*
- 首次发布：2025-01-30T09:26:05.110Z
- 最新版本发布：2026-11-12T13:39:12.697Z
- 近 30 天下载量：12320（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：28（近 12 个月 19 个）

## 中文简介

元素网络的 API 模块表面

## 安装

```sh
npm install @element-hq/element-web-module-api
```

也可以使用：`pnpm add @element-hq/element-web-module-api`、`yarn add @element-hq/element-web-module-api`、`bun add @element-hq/element-web-module-api`

## README

# @element-hq/element-web-module-api

API 表面,用于以安全和可预测的方式扩展 Element Web .

## 使用 API

模块由 Element Web 在运行时通过动态的外标导入来加载,但可以被捆绑到网络应用中以方便部署.

模块默认导出 MUST 是接受单个参数的类, 例如 `ModuleApi`。 。 。 . 此类还须有静态属性 `moduleApiVersion` 它是一个 semver 范围字符串 (单位:千美元) `load` 方法,在模块被装入时使用.

```typescript
import type { Module, Api, ModuleFactory } from "@element-hq/element-web-module-api";

class ExampleModule implements Module {
    public static readonly moduleApiVersion = "^2.0.0";

    public constructor(private api: Api) {}

    public async load(): Promise<void> {
        // Your extension code goes here
    }
}

export default ExampleModule satisfies ModuleFactory;
```

### 访问应用程序配置

这个 `api` 对象传递给模块构建器,提供对应用程序配置的访问. 您可以使用声明合并来扩展配置类型, 但请确保您不信任您指定的类型, 并由于配置的动态性质选择运行时间验证.

```typescript
// ...
declare module "@element-hq/element-web-module-api" {
    interface Config {
        "this.is.my.config.key": string;
    }
}

class ExampleModule implements Module {
    // ...
    public async load(): Promise<void> {
        const configValue = this.api.config.get("this.is.my.config.key");
        // Your extension code goes here
    }
}
// ...
```

## 释放

API的版本使用semver,主要版本为断开更改而加码.

为了执行释放,见文件: [`../RELEASING.md`](https://npmcn.com/package/%40element-hq/RELEASING.md)。 。 。 .

## 版权许可( L)

版权(c)2025新矢量有限公司

此软件由"新矢量"有限公司(Element)许可多种. 可用于:

(1) 根据GNU Affero通用公共许可证(由自由软件基金会出版,许可证第3版或(由你选择)以后的任何版本)的规定免费提供

(2) 根据贵方和贵方之间的有偿商业许可协议条款(其条款视贵方和贵方同意的内容而不同). 除非适用的法律要求或书面同意,否则根据许可证分发的软件在“AS IS”BASIS上分发,没有明示或默示的WARANTIES 或任何类型的软件。 见《许可证》中关于许可和限制的具体语言.

## 常见问题

### @element-hq/element-web-module-api 是什么？

元素网络的 API 模块表面

### 如何安装 @element-hq/element-web-module-api？

在项目目录运行 npm install @element-hq/element-web-module-api，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^19）、@types/react（\*）、@types/react-dom（\*）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @element-hq/element-web-module-api 支持 TypeScript 吗？

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

### @element-hq/element-web-module-api 支持 ESM 还是 CommonJS？

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

### @element-hq/element-web-module-api 需要什么版本的 Node\.js？

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

### @element-hq/element-web-module-api 可以商用吗？

@element-hq/element-web-module-api 使用 SEE LICENSE IN README\.md 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @element-hq/element-web-module-api 的下载量有多少？

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

### @element-hq/element-web-module-api 还在维护吗？

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