@celhive/tool.js 0.0.7 → 0.0.9

package/lib/index.d.ts

@@ -2,4 +2,5 @@ export * from './formatCitation';
 export * from './get-pdf-viewer-urll';
 export * from './markdown-patch';
 export * from './mock-stream';
+export * from './stable-streaming';
 export * from './token-exceeded';

package/lib/index.js

@@ -18,4 +18,5 @@ __exportStar(require("./formatCitation"), exports);
 __exportStar(require("./get-pdf-viewer-urll"), exports);
 __exportStar(require("./markdown-patch"), exports);
 __exportStar(require("./mock-stream"), exports);
+__exportStar(require("./stable-streaming"), exports);
 __exportStar(require("./token-exceeded"), exports);

package/lib/stable-streaming.d.ts

@@ -0,0 +1,18 @@
+interface stableStreamingProps {
+    /** Number of characters output per millisecond */
+    ratePerMs: number;
+}
+/**
+ * StableStreaming class to stream characters at a stable rate.
+ * It ensures that characters are output at the specified rate per millisecond,
+ */
+export declare class StableStreaming {
+    private options;
+    private queue;
+    private timer;
+    private pendingResolvers;
+    constructor(options: stableStreamingProps);
+    streaming(chars: string, callback: (char: string) => void): Promise<void>;
+    private start;
+}
+export {};

package/lib/stable-streaming.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StableStreaming = void 0;
+/**
+ * StableStreaming class to stream characters at a stable rate.
+ * It ensures that characters are output at the specified rate per millisecond,
+ */
+class StableStreaming {
+    constructor(options) {
+        this.queue = [];
+        this.timer = null;
+        this.pendingResolvers = [];
+        if (!options || options.ratePerMs <= 0) {
+            throw new Error('ratePerMs must be greater than 0');
+        }
+        this.options = options;
+    }
+    streaming(chars, callback) {
+        if (!chars)
+            return Promise.resolve();
+        this.queue.push(...chars.split(''));
+        return new Promise((resolve) => {
+            this.pendingResolvers.push(resolve);
+            if (!this.timer) {
+                this.start(callback);
+            }
+        });
+    }
+    start(callback) {
+        const charsPerTick = Math.max(1, Math.floor(this.options.ratePerMs));
+        this.timer = setInterval(() => {
+            let remaining = charsPerTick;
+            while (remaining > 0 && this.queue.length) {
+                const char = this.queue.shift();
+                if (char !== undefined) {
+                    callback(char);
+                }
+                remaining -= 1;
+            }
+            if (!this.queue.length) {
+                if (this.timer) {
+                    clearInterval(this.timer);
+                    this.timer = null;
+                }
+                this.pendingResolvers.forEach((resolver) => resolver());
+                this.pendingResolvers = [];
+            }
+        }, 1);
+    }
+}
+exports.StableStreaming = StableStreaming;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@celhive/tool.js",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "private": false,
   "publishConfig": {
     "access": "public"