# @easytunnel/et-sdk 中文文档

规范地址：https://npmcn.com/package/%40easytunnel/et-sdk/

版本：1\.6\.8
npm 元数据更新时间：2026-11-13T07:21:19.555Z
中文译文更新时间：2026-11-13T04:18:54.810Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：19.4 kB，4 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=22
- 运行依赖：0 个
- 首次发布：2026-11-08T09:10:44.365Z
- 最新版本发布：2026-11-13T07:21:19.003Z
- 近 30 天下载量：2574（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：20（近 12 个月 20 个）

## 中文简介

以一行代码向互联网展示本地服务:即时公用HTTPS URL 有自动TLS,通过NAT和防火墙,不注册. Webhook 友好的 ngrok 风格倒置地道,有20种语言的 SDK 和一个单二进制 Go 服务器.

## 安装

```sh
npm install @easytunnel/et-sdk
```

也可以使用：`pnpm add @easytunnel/et-sdk`、`yarn add @easytunnel/et-sdk`、`bun add @easytunnel/et-sdk`

## README

# 节点的正则

[![npm](https://img.shields.io/npm/v/@easytunnel/et-sdk?label=npm%20%40easytunnel%2Fet-sdk)](https://www.npmjs.com/package/@easytunnel/et-sdk)

通过 etunnel 逆通通通服务器曝光本地服务. 0依赖关系(Node QQ 22 内置 WebSocket).

零注册: 每个 SDK 客户端都说同样的微小线协议 (单位:千美元)[议定书.md](https://npmcn.com/package/PROTOCOL.md))针对任何正则服务器 (默认) `wss://t.etun.uk/tunnel`) (中文(简体) ).

## 安装

```
npm install @easytunnel/et-sdk
```

需要22号节点.

## 国 际

```
npx @easytunnel/et-sdk 3000
```

印刷品 `TUNNEL_URL: https://<subdomain>.t.etun.uk` ——该 URL 现在路径到 您的本地服务。 Ctrl-C关闭地道.

**自动重接.** 如果连接下降( 包括服务器) 重新启动) CLI 重排并有指数回放(500ms ~ 30s,±20%) 和打印 `TUNNEL_URL:` 再来一次 子域为 **已收回**,而不是重新随机:客户端重放服务器的签名 `resumeToken` 内 `hello.resume`,所以已共享的链接继续工作( 服务器需要一个稳定 `SESSION_SECRET`;见《议定书》第1条。 设定 `ETUNNEL_RECONNECT=0` 以恢复旧的一发行为.

## 嵌入

```js
const { connect } = require('@easytunnel/et-sdk');
const t = await connect('wss://t.etun.uk/tunnel', 3000);
console.log(t.url);
```

`connect(server, local, opts)` 选择第三个参数 : `token`, (中文(简体) ), `subdomain`, (中文(简体) ), `resume` (弦),和 `wsFactory` a 包括: `(serverUrl) => WebSocket` 使用的构造器注射,而不是全局 `WebSocket` (CLI通过 用于捕捉它创建的套接字的工厂)。 图书馆嵌入器 WebSocket 执行或每次连接插座应注入 `wsFactory`· ; global 从未被补丁过.

## 环境变量

| 变量 | 含义 | 默认 |
| --- | --- | --- |
| `ETUNNEL_SERVER` | 隧道服务器 WebSocket URL | `wss://t.etun.uk/tunnel` |
| `ETUNNEL_LOCAL` | 本地端口或 `host:port` (或第1个CLI参数) | `3000` |
| `ETUNNEL_TOKEN` | aPI 密钥( 可选) | \- 说吧 |
| `ETUNNEL_RECONNECT` | `0` 禁用自动重接( 一发 CLI) | 启用 |
| `ETUNNEL_SUBDOMAIN` | 自定义子域( 付费计划) | 随机 |

## 许可证

麻省理工学院——见 [自由主义](https://npmcn.com/package/LICENSE)。基于缓冲的协议客户端:请求和 反应机构每个流都得到缓冲(webhooks/dashboards/demos的罚款); 使用该 [冲去SDK](https://npmcn.com/package/sdk) 和WebSocket通过.

## 服务条件

使用 etunnel 中继服务( 默认) `wss://t.etun.uk/tunnel`) 被规范 联合国 [服务条件](https://t.etun.uk/terms) 财务报告和审定财务报表 [隐私政策](https://t.etun.uk/privacy)。 。 。 .

## 常见问题

### @easytunnel/et-sdk 是什么？

以一行代码向互联网展示本地服务:即时公用HTTPS URL 有自动TLS,通过NAT和防火墙,不注册\. Webhook 友好的 ngrok 风格倒置地道,有20种语言的 SDK 和一个单二进制 Go 服务器\.

### 如何安装 @easytunnel/et-sdk？

在项目目录运行 npm install @easytunnel/et-sdk，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 etunnel，可以用 npx etunnel 直接运行。

### @easytunnel/et-sdk 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/easytunnel\_\_et-sdk 是否存在。

### @easytunnel/et-sdk 支持 ESM 还是 CommonJS？

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

### @easytunnel/et-sdk 需要什么版本的 Node\.js？

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

### @easytunnel/et-sdk 可以商用吗？

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

### @easytunnel/et-sdk 的下载量有多少？

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

### @easytunnel/et-sdk 还在维护吗？

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