SSEClient

SSEClient 是一个用于处理服务器发送事件（Server-Sent Events，SSE）的 TypeScript 库。

特点

• 支持服务器发送事件（SSE）的客户端实现。
• 提供了详细的错误处理和状态码管理。
• 支持自定义请求头、请求方法和事件监听。
• 错误回调中包含错误代码，方便问题定位。

安装

pnpm install sseclient

使用方法

基本使用

import { SSEClient } from 'sseclient'

const client = new SSEClient('https://yourserver.com/sse', {
  headers: {
    CacheControl: 'no-cache',
    Connection: 'keep-alive',
    ContentType: 'application/json',
    Language: 'zh'
  },
  method: 'POST'
})

client.on('open', () => {
  console.log('SSE connection opened')
})

client.on('message', (data) => {
  console.log('Received message:', data)
})

client.on('error', (error) => {
  console.error(`SSE error: ${error.message}, Code: ${error.code}`)
})

client.on('close', () => {
  console.log('SSE connection closed')
})

client.send({ key: 'value' }) // 发送消息

错误代码

错误回调中的 code 属性是一个枚举值，表示不同的错误类型：

| 错误代码 | 描述 | | -------- | ------------------------------------ | | 4001 | 浏览器不支持 SSE | | 4002 | SSE执行错误 | | 4003 | SSE 连接错误 | | 4004 | 未知错误 | | 4005 | 该账号涉及敏感信息较多，已停用24小时 |

事件

• open: 当SSE连接打开时触发。
• message: 当接收到消息时触发。
• error: 当发生错误时触发，错误对象包含 code 和 message 属性。
• close: 当SSE连接关闭时触发。

注意

明途内部工具库，并不负责改BUG，请勿随便下载