@ahoo-wang/fetcher-eventstream 2.9.6 → 2.9.9

package/dist/textLineTransformStream.d.ts

@@ -1,9 +1,29 @@
 /**
  * Transformer that splits text into lines.
  *
- * This transformer accumulates chunks of text and splits them by newline characters,
- * emitting each line as a separate chunk while preserving the remaining buffer
- * for the next chunk.
+ * This transformer accumulates chunks of text and splits them by newline characters ('\n'),
+ * emitting each complete line as a separate chunk. It handles partial lines that span multiple
+ * input chunks by maintaining an internal buffer. Lines are emitted without the newline character.
+ *
+ * The transformer handles various edge cases:
+ * - Lines that span multiple input chunks
+ * - Empty lines (emitted as empty strings)
+ * - Text without trailing newlines (buffered until stream ends)
+ * - Mixed line endings (only '\n' is recognized as line separator)
+ *
+ * @implements {Transformer<string, string>}
+ *
+ * @example
+ * ```typescript
+ * const transformer = new TextLineTransformer();
+ * // Input: "line1\nline2\npartial"
+ * // Output: ["line1", "line2"]
+ * // Buffer: "partial"
+ *
+ * // Later input: "line\n"
+ * // Output: ["partialline"]
+ * // Buffer: ""
+ * ```
  */
 export declare class TextLineTransformer implements Transformer<string, string> {
     private buffer;
@@ -23,8 +43,49 @@ export declare class TextLineTransformer implements Transformer<string, string>
 }
 /**
  * A TransformStream that splits text into lines.
+ *
+ * This class provides a convenient way to transform a stream of text chunks into a stream
+ * of individual lines. It wraps the TextLineTransformer in a TransformStream for easy
+ * integration with other stream processing pipelines.
+ *
+ * The stream processes text data and emits each line as a separate chunk, handling
+ * lines that may span multiple input chunks automatically.
+ *
+ * @example
+ * ```typescript
+ * // Create a line-splitting stream
+ * const lineStream = new TextLineTransformStream();
+ *
+ * // Pipe text through it
+ * const lines = textStream.pipeThrough(lineStream);
+ *
+ * // Process each line
+ * for await (const line of lines) {
+ *   console.log('Line:', line);
+ * }
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Process SSE response line by line
+ * const response = await fetch('/api/stream');
+ * const lines = response.body!
+ *   .pipeThrough(new TextDecoderStream())
+ *   .pipeThrough(new TextLineTransformStream());
+ *
+ * for await (const line of lines) {
+ *   if (line.startsWith('data: ')) {
+ *     console.log('SSE data:', line.substring(6));
+ *   }
+ * }
+ * ```
  */
 export declare class TextLineTransformStream extends TransformStream<string, string> {
+    /**
+     * Creates a new TextLineTransformStream instance.
+     *
+     * Initializes the stream with a TextLineTransformer that handles the line splitting logic.
+     */
     constructor();
 }
 //# sourceMappingURL=textLineTransformStream.d.ts.map

package/dist/textLineTransformStream.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"textLineTransformStream.d.ts","sourceRoot":"","sources":["../src/textLineTransformStream.ts"],"names":[],"mappings":"AAaA;;;;;;GAMG;AACH,qBAAa,mBAAoB,YAAW,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC;IACrE,OAAO,CAAC,MAAM,CAAM;IAEpB;;;;;OAKG;IACH,SAAS,CACP,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,gCAAgC,CAAC,MAAM,CAAC;IAetD;;;;OAIG;IACH,KAAK,CAAC,UAAU,EAAE,gCAAgC,CAAC,MAAM,CAAC;CAU3D;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC;;CAI3E"}
+{"version":3,"file":"textLineTransformStream.d.ts","sourceRoot":"","sources":["../src/textLineTransformStream.ts"],"names":[],"mappings":"AAaA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,mBAAoB,YAAW,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC;IACrE,OAAO,CAAC,MAAM,CAAM;IAEpB;;;;;OAKG;IACH,SAAS,CACP,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,gCAAgC,CAAC,MAAM,CAAC;IAetD;;;;OAIG;IACH,KAAK,CAAC,UAAU,EAAE,gCAAgC,CAAC,MAAM,CAAC;CAU3D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,qBAAa,uBAAwB,SAAQ,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC;IAC1E;;;;OAIG;;CAIJ"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ahoo-wang/fetcher-eventstream",
-  "version": "2.9.6",
+  "version": "2.9.9",
   "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",