@ahoo-wang/fetcher-eventstream 3.15.1 → 3.15.3

package/README.md

@@ -15,7 +15,7 @@ APIs.
 ## 🌟 Features
 
 - **📡 Event Stream Conversion**: Converts `text/event-stream` responses to async generators of `ServerSentEvent` objects
-- **🔌 Interceptor Integration**: Automatically adds `eventStream()` and `jsonEventStream()` methods to responses with
+- **🔌 Side-Effect Module Import**: Automatically adds `eventStream()` and `jsonEventStream()` methods to the global `Response.prototype` for responses with
   `text/event-stream` content
   type
 - **📋 SSE Parsing**: Parses Server-Sent Events according to the specification, including data, event, id, and retry
@@ -312,43 +312,16 @@ try {
 
 ## 📚 API Reference
 
-### Module Import
-
-To use the event stream functionality, you need to import the module for its side effects:
-
-```typescript
-import '@ahoo-wang/fetcher-eventstream';
-```
-
-This import automatically extends the global `Response` interface with methods for handling Server-Sent Events streams:
-
-- `eventStream()` - Converts a Response with `text/event-stream` content type to a `ServerSentEventStream`
-- `jsonEventStream<DATA>()` - Converts a Response with `text/event-stream` content type to a
-  `JsonServerSentEventStream<DATA>`
-- `isEventStream` getter - Checks if the Response has a `text/event-stream` content type
-- `requiredEventStream()` - Gets a `ServerSentEventStream`, throwing an error if not available
-- `requiredJsonEventStream<DATA>()` - Gets a `JsonServerSentEventStream<DATA>`, throwing an error if not available
-
-This is a common pattern in JavaScript/TypeScript for extending existing types with additional functionality without
-modifying the original type definitions.
-
-In integration tests and real applications, this import is essential for working with event streams. For example:
-
-```typescript
-import { Fetcher } from '@ahoo-wang/fetcher';
-import '@ahoo-wang/fetcher-eventstream';
+### Response Prototype Extension
 
-const fetcher = new Fetcher({
-  baseURL: 'https://api.example.com',
-});
+Importing this module patches the global `Response.prototype` with the following properties:
 
-// Response objects will automatically have eventStream() and jsonEventStream() methods
-const response = await fetcher.get('/events');
-// Handle event stream
-for await (const event of response.requiredEventStream()) {
-  console.log('Received event:', event);
-}
-```
+- `contentType` - The Content-Type header value
+- `isEventStream` - Boolean getter, true if Content-Type is `text/event-stream`
+- `eventStream()` - Returns `ServerSentEventStream` if available, undefined otherwise
+- `requiredEventStream()` - Returns `ServerSentEventStream` or throws if not available
+- `jsonEventStream<DATA>()` - Returns `JsonServerSentEventStream<DATA>` if available
+- `requiredJsonEventStream<DATA>()` - Returns `JsonServerSentEventStream<DATA>` or throws if not available
 
 ### toJsonServerSentEventStream
 

package/README.zh-CN.md

@@ -283,41 +283,16 @@ try {
 
 ## 📚 API 参考
 
-### 模块导入
-
-要使用事件流功能，您需要导入模块以执行其副作用：
-
-```typescript
-import '@ahoo-wang/fetcher-eventstream';
-```
-
-此导入会自动扩展全局 `Response` 接口以处理服务器发送事件流：
-
-- `eventStream()` - 将带有 `text/event-stream` 内容类型的响应转换为 `ServerSentEventStream`
-- `jsonEventStream<DATA>()` - 将带有 `text/event-stream` 内容类型的响应转换为 `JsonServerSentEventStream<DATA>`
-- `isEventStream` getter - 检查响应是否具有 `text/event-stream` 内容类型
-- `requiredEventStream()` - 获取 `ServerSentEventStream`，如果不可用则抛出错误
-- `requiredJsonEventStream<DATA>()` - 获取 `JsonServerSentEventStream<DATA>`，如果不可用则抛出错误
-
-这是 JavaScript/TypeScript 中常见的模式，用于在不修改原始类型定义的情况下扩展现有类型的功能。
-
-在集成测试和实际应用中，此导入对于处理事件流至关重要。例如：
+### Response 原型扩展
 
-```typescript
-import { Fetcher } from '@ahoo-wang/fetcher';
-import '@ahoo-wang/fetcher-eventstream';
+导入此模块会通过以下属性对全局 `Response.prototype` 进行补丁：
 
-const fetcher = new Fetcher({
-  baseURL: 'https://api.example.com',
-});
-
-// Response 对象将自动具有 eventStream() 和 jsonEventStream() 方法
-const response = await fetcher.get('/events');
-// 处理事件流
-for await (const event of response.requiredEventStream()) {
-  console.log('收到事件:', event);
-}
-```
+- `contentType` - Content-Type 头部的值
+- `isEventStream` - 布尔值 getter，如果 Content-Type 是 `text/event-stream` 则为 true
+- `eventStream()` - 如果可用则返回 `ServerSentEventStream`，否则返回 undefined
+- `requiredEventStream()` - 返回 `ServerSentEventStream`，如果不可用则抛出错误
+- `jsonEventStream<DATA>()` - 如果可用则返回 `JsonServerSentEventStream<DATA>`
+- `requiredJsonEventStream<DATA>()` - 返回 `JsonServerSentEventStream<DATA>`，如果不可用则抛出错误
 
 ### toJsonServerSentEventStream
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ahoo-wang/fetcher-eventstream",
-  "version": "3.15.1",
+  "version": "3.15.3",
   "description": "Server-Sent Events (SSE) support for Fetcher HTTP client with native LLM streaming API support. Enables real-time data streaming and token-by-token LLM response handling.",
   "keywords": [
     "fetch",
@@ -46,10 +46,10 @@
     "@vitest/coverage-v8": "^4.1.4",
     "@vitest/ui": "^4.1.4",
     "eslint": "^9.39.4",
-    "globals": "^17.4.0",
+    "globals": "^17.5.0",
     "prettier": "^3.8.1",
     "typescript": "^6.0.2",
-    "typescript-eslint": "^8.58.1",
+    "typescript-eslint": "^8.58.2",
     "unplugin-dts": "1.0.0-beta.6",
     "vite": "^8.0.8",
     "vite-bundle-analyzer": "^1.3.7",