@standardserver/fetch 0.0.22 → 0.0.24

package/dist/index.d.mts

@@ -4,38 +4,54 @@ import { AsyncIteratorClass } from '@standardserver/shared';
 declare function toEventIterator(stream: ReadableStream<Uint8Array<ArrayBuffer>> | null): AsyncIteratorClass<unknown>;
 interface ToEventStreamOptions {
     /**
-     * If true, a ping comment is sent periodically to keep the connection alive.
-     *
-     * @default true
-     */
-    keepAliveEnabled?: boolean;
-    /**
-     * Interval (in milliseconds) between ping comments sent after the last event.
-     *
-     * @default 5000
-     */
-    keepAliveInterval?: number;
-    /**
-     * The content of the ping comment. Must not include newline characters.
-     *
-     * @default ''
-     */
-    keepAliveComment?: string;
-    /**
-     * If true, an initial comment is sent immediately upon stream start to flush headers.
+     * If enabled, an initial comment is sent immediately upon stream start to flush headers.
      * This allows the receiving side to establish the connection without waiting for the first event.
      *
-     * @default true
+     * @default { enabled: true }
      */
-    initialCommentEnabled?: boolean;
+    initialComment?: undefined | {
+        /**
+         * If true, an initial comment is sent immediately upon stream start to flush headers.
+         * This allows the receiving side to establish the connection without waiting for the first event.
+         *
+         * @default true
+         */
+        enabled?: boolean;
+        /**
+         * The content of the initial comment sent upon stream start. Must not include newline characters.
+         *
+         * @default ''
+         */
+        comment?: string;
+    };
     /**
-     * The content of the initial comment sent upon stream start. Must not include newline characters.
+     * If enabled, a ping comment is sent periodically to keep the connection alive.
      *
-     * @default ''
+     * @default { enabled: true }
      */
-    initialComment?: string;
+    keepAlive?: undefined | {
+        /**
+         * If true, a ping comment is sent periodically to keep the connection alive.
+         *
+         * @default true
+         */
+        enabled: boolean;
+        /**
+         * Interval (in milliseconds) between ping comments sent after the last event.
+         *
+         * @default 5000
+         */
+        interval?: number;
+        /**
+         * The content of the ping comment. Must not include newline characters.
+         *
+         * @default ''
+         */
+        comment?: string;
+    };
     /**
-     * If true, a empty `close` event is sent when the iterator completes with `undefined`.
+     * If true, a `close` event is sent even when the iterator completes with `undefined`.
+     * When the iterator returns a value, a `close` event is always emitted regardless of this setting.
      *
      * @default true
      */

package/dist/index.d.ts

@@ -4,38 +4,54 @@ import { AsyncIteratorClass } from '@standardserver/shared';
 declare function toEventIterator(stream: ReadableStream<Uint8Array<ArrayBuffer>> | null): AsyncIteratorClass<unknown>;
 interface ToEventStreamOptions {
     /**
-     * If true, a ping comment is sent periodically to keep the connection alive.
-     *
-     * @default true
-     */
-    keepAliveEnabled?: boolean;
-    /**
-     * Interval (in milliseconds) between ping comments sent after the last event.
-     *
-     * @default 5000
-     */
-    keepAliveInterval?: number;
-    /**
-     * The content of the ping comment. Must not include newline characters.
-     *
-     * @default ''
-     */
-    keepAliveComment?: string;
-    /**
-     * If true, an initial comment is sent immediately upon stream start to flush headers.
+     * If enabled, an initial comment is sent immediately upon stream start to flush headers.
      * This allows the receiving side to establish the connection without waiting for the first event.
      *
-     * @default true
+     * @default { enabled: true }
      */
-    initialCommentEnabled?: boolean;
+    initialComment?: undefined | {
+        /**
+         * If true, an initial comment is sent immediately upon stream start to flush headers.
+         * This allows the receiving side to establish the connection without waiting for the first event.
+         *
+         * @default true
+         */
+        enabled?: boolean;
+        /**
+         * The content of the initial comment sent upon stream start. Must not include newline characters.
+         *
+         * @default ''
+         */
+        comment?: string;
+    };
     /**
-     * The content of the initial comment sent upon stream start. Must not include newline characters.
+     * If enabled, a ping comment is sent periodically to keep the connection alive.
      *
-     * @default ''
+     * @default { enabled: true }
      */
-    initialComment?: string;
+    keepAlive?: undefined | {
+        /**
+         * If true, a ping comment is sent periodically to keep the connection alive.
+         *
+         * @default true
+         */
+        enabled: boolean;
+        /**
+         * Interval (in milliseconds) between ping comments sent after the last event.
+         *
+         * @default 5000
+         */
+        interval?: number;
+        /**
+         * The content of the ping comment. Must not include newline characters.
+         *
+         * @default ''
+         */
+        comment?: string;
+    };
     /**
-     * If true, a empty `close` event is sent when the iterator completes with `undefined`.
+     * If true, a `close` event is sent even when the iterator completes with `undefined`.
+     * When the iterator returns a value, a `close` event is always emitted regardless of this setting.
      *
      * @default true
      */

package/dist/index.mjs

@@ -47,11 +47,11 @@ function toEventIterator(stream) {
   });
 }
 function toEventStream(iterator, options = {}) {
-  const keepAliveEnabled = options.keepAliveEnabled ?? true;
-  const keepAliveInterval = options.keepAliveInterval ?? 5e3;
-  const keepAliveComment = options.keepAliveComment ?? "";
-  const initialCommentEnabled = options.initialCommentEnabled ?? true;
-  const initialComment = options.initialComment ?? "";
+  const keepAliveEnabled = options.keepAlive?.enabled ?? true;
+  const keepAliveInterval = options.keepAlive?.interval ?? 5e3;
+  const keepAliveComment = options.keepAlive?.comment ?? "";
+  const initialCommentEnabled = options.initialComment?.enabled ?? true;
+  const initialComment = options.initialComment?.comment ?? "";
   const emptyCloseEventEnabled = options.emptyCloseEventEnabled ?? true;
   let cancelled = false;
   let timeout;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@standardserver/fetch",
   "type": "module",
-  "version": "0.0.22",
+  "version": "0.0.24",
   "license": "MIT",
   "homepage": "https://standardserver.dev",
   "repository": {
@@ -22,8 +22,8 @@
     "dist"
   ],
   "dependencies": {
-    "@standardserver/core": "0.0.22",
-    "@standardserver/shared": "0.0.22"
+    "@standardserver/core": "0.0.24",
+    "@standardserver/shared": "0.0.24"
   },
   "devDependencies": {
     "@hono/node-server": "^2.0.1"