# @codex-app-sdk/web 中文文档

规范地址：https://npmcn.com/package/%40codex-app-sdk/web/

版本：0\.23\.0
npm 元数据更新时间：2026-11-09T21:43:41.332Z
中文译文更新时间：2026-11-10T08:22:50.136Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40codex-app-sdk/web
原文对照：https://npmcn.com/package/%40codex-app-sdk/web/?lang=original
项目主页：https://github.com/codex-app-sdk/codex-app-sdk#readme
源码仓库：https://github.com/codex-app-sdk/codex-app-sdk

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

- 包体积（解压后）：102 kB，22 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：1 个
- 首次发布：2026-10-06T12:47:12.736Z
- 最新版本发布：2026-11-09T21:43:40.967Z
- 近 30 天下载量：6505（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：44（近 12 个月 44 个）

## 中文简介

框架中立的WebSocket为基于浏览器的Codex应用程序装订.

## 安装

```sh
npm install @codex-app-sdk/web
```

也可以使用：`pnpm add @codex-app-sdk/web`、`yarn add @codex-app-sdk/web`、`bun add @codex-app-sdk/web`

## README

# `@codex-app-sdk/web`

用于浏览器 Codex 表面的框架中立 WebSocket 传输.

```bash
npm install @codex-app-sdk/core @codex-app-sdk/web
```

-   `@codex-app-sdk/web/client` 创建重连接浏览器侧面 `CodexSurfaceRendererApi`。 。 。 .
-   `@codex-app-sdk/web/server` 将已被接受的套接字绑定到 东道方授权的地表租赁.
-   `@codex-app-sdk/web/protocol` 导出自定义的已版本信封 运输一体化.

两个端点都默认为64 MiB 消息天花板. 服务器适配器可以包装 执行的 EventEmitter 类子集 `ws`,或者主机可以执行 `CodexWebSocketPort` 为另一个图书馆.

软件包不创建 HTTP 服务器,解析 cookie, 认证用户, 存储符牌, 管理 `codexHome` 目录、 集合应用程序服务器进程、 创建 上传路线,或依赖快递或WebSocket执行. 这些是 主机-应用程序责任.

见 [网络集成 指南](https://codex-app-sdk.github.io/codex-app-sdk/guide/web.html), (中文(简体) ), [网络 API 密码](https://codex-app-sdk.github.io/codex-app-sdk/api/web.html),以及 [基本快递 样本](https://github.com/codex-app-sdk/codex-app-sdk/tree/main/samples/web/basic)。 。 。 .

## 常见问题

### @codex-app-sdk/web 是什么？

框架中立的WebSocket为基于浏览器的Codex应用程序装订\.

### 如何安装 @codex-app-sdk/web？

在项目目录运行 npm install @codex-app-sdk/web，或使用 pnpm add / yarn add / bun add。

### @codex-app-sdk/web 支持 TypeScript 吗？

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

### @codex-app-sdk/web 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @codex-app-sdk/web 需要什么版本的 Node\.js？

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

### @codex-app-sdk/web 可以商用吗？

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

### @codex-app-sdk/web 的下载量有多少？

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

### @codex-app-sdk/web 还在维护吗？

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