@github/stable-socket

中文文档
1.1.1发布于 2024/10/15MITTypeScriptES Module零依赖构建来源已验证近 30 天下载 7523

重新连接的网络套接字 .

中文使用文档
文档目录6 节
  1. 安装
  2. 使用量
  3. 缓冲套装
  4. 同步连接
  5. 发展
  6. 许可证

稳定袜子

重新连接的网络套接字 .

安装

$ npm install @github/stable-socket

使用量

import {StableSocket} from '@github/stable-socket'

const delegate = {
  socketDidOpen(socket: Socket) {
    // Socket is ready to write.
    socket.send('Hello')
  },
  socketDidClose(socket: Socket, code?: number, reason?: string) {
    // Socket closed and will retry the connection.
  },
  socketDidFinish(socket: Socket) {
    // Socket closed for good and will not retry.
  },
  socketDidReceiveMessage(socket: Socket, message: string) {
    // Socket read data from the connection.
  },
  socketShouldRetry(socket: Socket, code: number): boolean {
    // Socket reconnects unless server returns the policy violation code.
    return code !== 1008
  }
}

const policy = {
  timeout: 4000,
  attempts: Infinity,
  maxDelay: 60000
}

const url = 'wss://live.example.com'
const socket = new StableSocket(url , delegate, policy)
socket.open()

缓冲套装

在打开状态或关闭状态时写入 StableSocket 丢弃信件数据。 使用缓冲Socket来缓冲写入 当它打开时发送.

import {BufferedSocket, StableSocket} from '@github/stable-socket'
const socket = new BufferedSocket(new StableSocket(url, delegate, policy))
socket.open()
socket.send('hello') // Will be sent when the socket is open.

同步连接

StableSocket 和 BufferedSocket 是对一个 WebSocket 的抽象化 维护内部的状态机器,管理重新连接和阻止写作 打开插座。 然而,有时我们需要直接访问一个开放的WebSocket 函数.

连接

同步连接到网络套接字端口, 或者在超时后失败 。 这个 套接字打开, 可写入 send当诺言实现的时候. 返回以打开的 WebSocket 实现的承诺或以拒绝方式拒绝的承诺 连接失败 .

import {connect} from '@github/stable-socket'

try {
  const socket = await connect('wss://live.example.com', 100)
  socket.send('hi')
} catch (e) {
  console.log('Socket connection failed', e)
}

与 Retry 连接

同步连接到网络套接字端口, 重试失败的连接 以指数回放。 返回以打开的 WebSocket 实现的承诺 或以连接失败拒绝.

import {connectWithRetry} from '@github/stable-socket'

try {
  const policy = {timeout: 100, attempts: Infinity, maxDelay: 60000}
  const socket = await connectWithRetry('wss://live.example.com', policy)
  socket.send('hi')
} catch (e) {
  console.log('Socket connection failed', e)
}

发展

npm install
npm test

许可证

以麻省理工学院许可证分发。 详情见LICENSE.

版本与发布记录

@github/stable-socket 共发布 6 个版本,首次发布于 2020/07/14;过去 12 个月发布了 0 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.1.1latest2024/10/152 年前
1.1.02021/10/235 年前
1.0.02020/10/156 年前
0.1.22020/07/146 年前
0.1.12020/07/146 年前
0.1.02020/07/146 年前

关于 @github/stable-socket 的常见问题

@github/stable-socket 是什么?

重新连接的网络套接字 .

如何安装 @github/stable-socket?

在项目目录运行 npm install @github/stable-socket,或使用 pnpm add / yarn add / bun add。

@github/stable-socket 支持 TypeScript 吗?

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

@github/stable-socket 支持 ESM 还是 CommonJS?

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

@github/stable-socket 可以商用吗?

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

@github/stable-socket 的下载量有多少?

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

@github/stable-socket 还在维护吗?

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