@ahoo-wang/fetcher-eventstream 0.0.3 → 0.0.5

package/README.md

@@ -1,5 +1,11 @@
 # @ahoo-wang/fetcher-eventstream
 
+[![npm version](https://img.shields.io/npm/v/@ahoo-wang/fetcher-eventstream.svg)](https://www.npmjs.com/package/@ahoo-wang/fetcher-eventstream)
+[![Build Status](https://github.com/Ahoo-Wang/fetcher/actions/workflows/ci.yml/badge.svg)](https://github.com/Ahoo-Wang/fetcher/actions)
+[![codecov](https://codecov.io/gh/Ahoo-Wang/Fetcher/graph/badge.svg?token=CUPgk8DmH5)](https://codecov.io/gh/Ahoo-Wang/Fetcher)
+[![License](https://img.shields.io/npm/l/@ahoo-wang/fetcher-eventstream.svg)](https://github.com/Ahoo-Wang/fetcher/blob/main/LICENSE)
+[![npm downloads](https://img.shields.io/npm/dm/@ahoo-wang/fetcher-eventstream.svg)](https://www.npmjs.com/package/@ahoo-wang/fetcher-eventstream)
+
 Support for text/event-stream in Fetcher, enabling Server-Sent Events (SSE) functionality.
 
 ## Features

package/dist/eventStreamConverter.d.ts

@@ -1,14 +1,14 @@
 import { ServerSentEventStream } from './serverSentEventTransformStream';
 /**
- * 负责处理事件流响应，包括将响应(Response)转换为事件流（ReadableStream<ServerSentEvent>）。
+ * Responsible for handling event stream responses, including converting Response to event stream (ReadableStream<ServerSentEvent>).
  */
 export declare class EventStreamConverter {
     /**
-     * 将HTTP响应转换为服务器发送事件流
+     * Convert HTTP response to server-sent event stream
      *
-     * @param response - HTTP响应对象，应包含text/event-stream格式的数据
-     * @returns ServerSentEventStream - 服务器事件流，可用于读取服务器发送的事件
-     * @throws Error - 当响应体为空时抛出错误
+     * @param response - HTTP response object, should contain text/event-stream formatted data
+     * @returns ServerSentEventStream - Server event stream, can be used to read events sent by the server
+     * @throws Error - Throws error when response body is null
      */
     static toEventStream(response: Response): ServerSentEventStream;
 }

package/dist/index.es.js

@@ -55,9 +55,9 @@ class u {
     };
   }
   /**
-   * 转换输入的字符串块为 ServerSentEvent 对象
-   * @param chunk 输入的字符串块
-   * @param controller 用于控制转换流的控制器
+   * Transform input string chunk into ServerSentEvent object
+   * @param chunk Input string chunk
+   * @param controller Controller for controlling the transform stream
    */
   transform(t, r) {
     let e = this.currentEvent;
@@ -84,8 +84,8 @@ class u {
     }
   }
   /**
-   * 在流结束时调用，用于处理剩余的数据
-   * @param controller 用于控制转换流的控制器
+   * Called when the stream ends, used to process remaining data
+   * @param controller Controller for controlling the transform stream
    */
   flush(t) {
     let r = this.currentEvent;
@@ -113,11 +113,11 @@ class m extends TransformStream {
 }
 class y {
   /**
-   * 将HTTP响应转换为服务器发送事件流
+   * Convert HTTP response to server-sent event stream
    *
-   * @param response - HTTP响应对象，应包含text/event-stream格式的数据
-   * @returns ServerSentEventStream - 服务器事件流，可用于读取服务器发送的事件
-   * @throws Error - 当响应体为空时抛出错误
+   * @param response - HTTP response object, should contain text/event-stream formatted data
+   * @returns ServerSentEventStream - Server event stream, can be used to read events sent by the server
+   * @throws Error - Throws error when response body is null
    */
   static toEventStream(t) {
     if (!t.body)

package/dist/serverSentEventTransformStream.d.ts

@@ -23,20 +23,20 @@ export declare enum ServerSentEventField {
     DATA = "data"
 }
 /**
- * ServerSentEventTransformer 负责将字符串流转换为 ServerSentEvent 对象流
- * 实现了 Transformer 接口，用于 TransformStream 中处理数据转换
+ * ServerSentEventTransformer is responsible for converting a string stream into a ServerSentEvent object stream
+ * Implements the Transformer interface for processing data transformation in TransformStream
  */
 export declare class ServerSentEventTransformer implements Transformer<string, ServerSentEvent> {
     private currentEvent;
     /**
-     * 转换输入的字符串块为 ServerSentEvent 对象
-     * @param chunk 输入的字符串块
-     * @param controller 用于控制转换流的控制器
+     * Transform input string chunk into ServerSentEvent object
+     * @param chunk Input string chunk
+     * @param controller Controller for controlling the transform stream
      */
     transform(chunk: string, controller: TransformStreamDefaultController<ServerSentEvent>): void;
     /**
-     * 在流结束时调用，用于处理剩余的数据
-     * @param controller 用于控制转换流的控制器
+     * Called when the stream ends, used to process remaining data
+     * @param controller Controller for controlling the transform stream
      */
     flush(controller: TransformStreamDefaultController<ServerSentEvent>): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ahoo-wang/fetcher-eventstream",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "Support for text/event-stream in Fetcher",
   "keywords": [
     "fetch",
@@ -25,6 +25,9 @@
   "files": [
     "dist"
   ],
+  "dependencies": {
+    "@ahoo-wang/fetcher": "0.0.5"
+  },
   "devDependencies": {
     "@vitest/coverage-v8": "^3.2.4",
     "eslint": "^9.33.0",