@chromaui/localtunnel

中文文档
2.0.4发布于 2021/09/17MITCommonJS近 30 天下载 14万

向世界展示当地主人

中文使用文档
文档目录9 节
  1. 安装
  2. CLI 使用情况
  3. 参数
  4. API 密码
  5. localtunnel( 端口 [,可选 [,可召回])
  6. 隧道
  7. 其他客户
  8. 服务器
  9. 许可证

@chromaui/ 本地隧道

本地隧道将你的本地主机曝光给世界 以方便测试和分享! 不需要和DNS搞混 或部署 只是让别人测试你的改变.

对浏览器测试工具如浏览器或外部的 api 调用服务如 twilio 的操作很有帮助, 调用需要公开 URL .

安装

yarn add @chromaui/localtunnel

CLI 使用情况

假设您的本地服务器运行在 8000 端口上, 请使用 lt 命令启动隧道.

lt --port 8000

就这样! 它会连接到隧道服务器, 设置隧道, 并告诉你什么url用于你的测试。 这个url在您开会期间会一直活跃;所以,请随意与他人分享,以享受快乐的时光!

您可以任意重启本地服务器, lt 足够聪明,可以探测到它,一旦它回来就重新连接.

参数

以下是一些常见的论点。 见 lt --help 补充论据

  • --subdomain 请求本地隧道服务器上的已命名子域( 默认为随机字符)
  • --local-host 代理给本地主机以外的主机名

您也可以通过env变量指定参数。 E.x. (英语).

PORT=3000 lt

API 密码

本地隧道客户端也可以通过API(用于测试集成,自动化等)使用

localtunnel( 端口 [,可选 [,可召回])

为指定的本地创建新的本地隧道 port将返回一个承诺,一旦你被分配到一个公共的本地隧道url . options 可用于请求特定 subdomainA级 callback 函数可以被传递,在这种情况下它不会返回一个承诺. 用于与旧节点风格的回调 API 的后向兼容性 。 您也可以通过单个选项对象 port 作为财产.

const localtunnel = require('@chromaui/localtunnel');

(async () => {
  const tunnel = await localtunnel({ port: 3000 });

  // the assigned public url for your tunnel
  // i.e. https://abcdefgjhij.localtunnel.me
  tunnel.url;

  tunnel.on('close', () => {
    // tunnels are closed
  });
})();

选项

  • port (数目) [需 通过本地隧道曝光的本地端口号.
  • subdomain (字符串)请求代理服务器上的特定子域. 说明 您可能无法根据可用性获得此名称 .
  • host 上游代理服务器的 (字符串) URL 。 默认为 https://localtunnel.me。 。 。 .
  • local_host (字符串) 代理到此主机名而不是 localhost。这也会导致 Host 在代理请求中重写为此值的页眉 .
  • local_https (boolean) 启用地道通到本地的 HTTPS 服务器.
  • local_cert (字符串) 本地 HTTPS 服务器的 PEM 文件证书路径 .
  • local_key (字符串) 本地 HTTPS 服务器证书密钥文件的路径 .
  • local_ca (字符串) 自签名证书的证书权威文件路径 .
  • allow_invalid_cert (boolean) 禁用您本地 HTTPS 服务器的证书检查( ignoore cert/ key/ca 选项) .

参见 tls.create 保存文本 关于证书选项的详情.

隧道

这个 tunnel 实例返回到您的召回中

事件参数说明
请求资讯由隧道处理请求时起火,包含 方法 财务报告和审定财务报表 路径 字段
错误错误当隧道出错时起火
关闭隧道关闭时起火

这个 tunnel 实例有以下方法:

方法参数说明
关闭关闭地道

其他客户

其他语言客户端

离开 打开我

离开 本地隧道

C#/. NET (中文(简体) ) 本地隧道客户端

服务器

见 本地隧道/服务器 用于在服务器上授权本地隧道的细节.

许可证

麻省理工学院

版本与发布记录

@chromaui/localtunnel 共发布 10 个版本,首次发布于 2018/10/01;过去 12 个月发布了 0 个版本。

版本发布日期距今
2.0.4latest2021/09/175 年前
2.0.32021/02/175 年前
2.0.22021/01/225 年前
2.0.12019/08/257 年前
2.0.02019/07/167 年前
1.10.12019/07/167 年前

关于 @chromaui/localtunnel 的常见问题

@chromaui/localtunnel 是什么?

向世界展示当地主人

如何安装 @chromaui/localtunnel?

在项目目录运行 npm install @chromaui/localtunnel,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 lt,可以用 npx lt 直接运行。

@chromaui/localtunnel 支持 TypeScript 吗?

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

@chromaui/localtunnel 支持 ESM 还是 CommonJS?

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

@chromaui/localtunnel 需要什么版本的 Node.js?

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

@chromaui/localtunnel 可以商用吗?

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

@chromaui/localtunnel 的下载量有多少?

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

@chromaui/localtunnel 还在维护吗?

最新版本 2.0.4 发布于 2021/09/17(5 年前);至今共发布 10 个版本,其中过去 12 个月发布了 0 个;首次发布于 2018/10/01。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。