@ahoo-wang/fetcher-eventstream 0.0.3 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +7 -0
  2. package/dist/eventStreamConverter.d.ts +5 -5
  3. package/dist/index.es.js +9 -9
  4. package/dist/serverSentEventTransformStream.d.ts +7 -7
  5. package/package.json +1 -1
package/README.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # @ahoo-wang/fetcher-eventstream
2
2
 
3
+ [![npm version](https://img.shields.io/npm/v/@ahoo-wang/fetcher-eventstream.svg)](https://www.npmjs.com/package/@ahoo-wang/fetcher-eventstream)
4
+ [![Build Status](https://github.com/Ahoo-Wang/fetcher/actions/workflows/ci.yml/badge.svg)](https://github.com/Ahoo-Wang/fetcher/actions)
5
+ [![codecov](https://codecov.io/gh/Ahoo-Wang/Fetcher/graph/badge.svg?token=CUPgk8DmH5)](https://codecov.io/gh/Ahoo-Wang/Fetcher)
6
+ [![License](https://img.shields.io/npm/l/@ahoo-wang/fetcher-eventstream.svg)](https://github.com/Ahoo-Wang/fetcher/blob/main/LICENSE)
7
+ [![npm downloads](https://img.shields.io/npm/dm/@ahoo-wang/fetcher-eventstream.svg)](https://www.npmjs.com/package/@ahoo-wang/fetcher-eventstream)
8
+ [![Bundle Size](https://img.shields.io/bundlephobia/minzip/@ahoo-wang/fetcher-eventstream.svg)](https://bundlephobia.com/package/@ahoo-wang/fetcher-eventstream)
9
+
3
10
  Support for text/event-stream in Fetcher, enabling Server-Sent Events (SSE) functionality.
4
11
 
5
12
  ## Features
package/dist/eventStreamConverter.d.ts CHANGED
@@ -1,14 +1,14 @@
1
1
  import { ServerSentEventStream } from './serverSentEventTransformStream';
2
2
  /**
3
- * 负责处理事件流响应，包括将响应(Response)转换为事件流（ReadableStream<ServerSentEvent>）。
3
+ * Responsible for handling event stream responses, including converting Response to event stream (ReadableStream<ServerSentEvent>).
4
4
  */
5
5
  export declare class EventStreamConverter {
6
6
  /**
7
- * 将HTTP响应转换为服务器发送事件流
7
+ * Convert HTTP response to server-sent event stream
8
8
  *
9
- * @param response - HTTP响应对象，应包含text/event-stream格式的数据
10
- * @returns ServerSentEventStream - 服务器事件流，可用于读取服务器发送的事件
11
- * @throws Error - 当响应体为空时抛出错误
9
+ * @param response - HTTP response object, should contain text/event-stream formatted data
10
+ * @returns ServerSentEventStream - Server event stream, can be used to read events sent by the server
11
+ * @throws Error - Throws error when response body is null
12
12
  */
13
13
  static toEventStream(response: Response): ServerSentEventStream;
14
14
  }
package/dist/index.es.js CHANGED
@@ -55,9 +55,9 @@ class u {
55
55
  };
56
56
  }
57
57
  /**
58
- * 转换输入的字符串块为 ServerSentEvent 对象
59
- * @param chunk 输入的字符串块
60
- * @param controller 用于控制转换流的控制器
58
+ * Transform input string chunk into ServerSentEvent object
59
+ * @param chunk Input string chunk
60
+ * @param controller Controller for controlling the transform stream
61
61
  */
62
62
  transform(t, r) {
63
63
  let e = this.currentEvent;
@@ -84,8 +84,8 @@ class u {
84
84
  }
85
85
  }
86
86
  /**
87
- * 在流结束时调用，用于处理剩余的数据
88
- * @param controller 用于控制转换流的控制器
87
+ * Called when the stream ends, used to process remaining data
88
+ * @param controller Controller for controlling the transform stream
89
89
  */
90
90
  flush(t) {
91
91
  let r = this.currentEvent;
@@ -113,11 +113,11 @@ class m extends TransformStream {
113
113
  }
114
114
  class y {
115
115
  /**
116
- * 将HTTP响应转换为服务器发送事件流
116
+ * Convert HTTP response to server-sent event stream
117
117
  *
118
- * @param response - HTTP响应对象，应包含text/event-stream格式的数据
119
- * @returns ServerSentEventStream - 服务器事件流，可用于读取服务器发送的事件
120
- * @throws Error - 当响应体为空时抛出错误
118
+ * @param response - HTTP response object, should contain text/event-stream formatted data
119
+ * @returns ServerSentEventStream - Server event stream, can be used to read events sent by the server
120
+ * @throws Error - Throws error when response body is null
121
121
  */
122
122
  static toEventStream(t) {
123
123
  if (!t.body)
package/dist/serverSentEventTransformStream.d.ts CHANGED
@@ -23,20 +23,20 @@ export declare enum ServerSentEventField {
23
23
  DATA = "data"
24
24
  }
25
25
  /**
26
- * ServerSentEventTransformer 负责将字符串流转换为 ServerSentEvent 对象流
27
- * 实现了 Transformer 接口，用于 TransformStream 中处理数据转换
26
+ * ServerSentEventTransformer is responsible for converting a string stream into a ServerSentEvent object stream
27
+ * Implements the Transformer interface for processing data transformation in TransformStream
28
28
  */
29
29
  export declare class ServerSentEventTransformer implements Transformer<string, ServerSentEvent> {
30
30
  private currentEvent;
31
31
  /**
32
- * 转换输入的字符串块为 ServerSentEvent 对象
33
- * @param chunk 输入的字符串块
34
- * @param controller 用于控制转换流的控制器
32
+ * Transform input string chunk into ServerSentEvent object
33
+ * @param chunk Input string chunk
34
+ * @param controller Controller for controlling the transform stream
35
35
  */
36
36
  transform(chunk: string, controller: TransformStreamDefaultController<ServerSentEvent>): void;
37
37
  /**
38
- * 在流结束时调用，用于处理剩余的数据
39
- * @param controller 用于控制转换流的控制器
38
+ * Called when the stream ends, used to process remaining data
39
+ * @param controller Controller for controlling the transform stream
40
40
  */
41
41
  flush(controller: TransformStreamDefaultController<ServerSentEvent>): void;
42
42
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ahoo-wang/fetcher-eventstream",
3
- "version": "0.0.3",
3
+ "version": "0.0.4",
4
4
  "description": "Support for text/event-stream in Fetcher",
5
5
  "keywords": [
6
6
  "fetch",