@flexent/ws-proxy

中文文档
2.22.1发布于 2026/11/13MITES Module零依赖近 30 天下载 2238

Transparent WebSocket upgrade relay for Node.js HTTP servers

原始使用文档

@flexent/ws-proxy

Transparent WebSocket upgrade relay for Node.js HTTP servers.

Usage

Subclass WsProxy and implement processConnection to authenticate, open the outbound socket, and specify the upgrade request to send upstream:

import { connectToUrl, WsProxy, WsProxyContext, WsProxyRelay } from '@flexent/ws-proxy';

class MyProxy extends WsProxy {

    protected async processConnection(ctx: WsProxyContext): Promise<WsProxyRelay> {
        const outbound = await connectToUrl('wss://upstream.example/lease');
        return {
            outbound,
            upgrade: {
                path: '/lease?t=token',
                host: 'upstream.example',
                omitHeaders: ['authorization'],
            },
        };
    }

}

Call onUpgrade from your HTTP server's upgrade event to relay the WebSocket handshake and stream data bidirectionally.

版本与发布记录

@flexent/ws-proxy 共发布 17 个版本,首次发布于 2026/07/10;过去 12 个月发布了 17 个版本。

版本发布日期距今
2.22.1latest2026/11/132 天前
2.22.02026/11/132 天前
2.21.02026/11/132 天前
2.20.22026/11/133 天前
2.20.12026/11/115 天前
2.20.02026/11/069 天前

关于 @flexent/ws-proxy 的常见问题

@flexent/ws-proxy 是什么?

Transparent WebSocket upgrade relay for Node.js HTTP servers

如何安装 @flexent/ws-proxy?

在项目目录运行 npm install @flexent/ws-proxy,或使用 pnpm add / yarn add / bun add。

@flexent/ws-proxy 支持 TypeScript 吗?

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

@flexent/ws-proxy 支持 ESM 还是 CommonJS?

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

@flexent/ws-proxy 可以商用吗?

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

@flexent/ws-proxy 的下载量有多少?

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

@flexent/ws-proxy 还在维护吗?

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