@bbn/bbn 1.0.424 → 1.0.426

package/dist/fn/browser/executeSlowly.d.ts

@@ -1 +1,7 @@
-export default function executeSlowly(arr: any[], fn: Function): Promise<void>;
+/**
+ * Executes a function on each element of an array slowly, yielding to the browser in between.
+ * @param arr The array to iterate over.
+ * @param fn The function to execute on each element. If the function returns false, the iteration stops.
+ * @returns A promise that resolves to true if the iteration completed, or false if it was stopped early.
+ */
+export default function executeSlowly(arr: any[], fn: Function): Promise<boolean>;

package/dist/fn/browser/executeSlowly.js

@@ -35,6 +35,12 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 import yieldToBrowser from './yieldToBrowser.js';
+/**
+ * Executes a function on each element of an array slowly, yielding to the browser in between.
+ * @param arr The array to iterate over.
+ * @param fn The function to execute on each element. If the function returns false, the iteration stops.
+ * @returns A promise that resolves to true if the iteration completed, or false if it was stopped early.
+ */
 export default function executeSlowly(arr, fn) {
     return __awaiter(this, void 0, void 0, function () {
         var i, res;
@@ -53,7 +59,7 @@ export default function executeSlowly(arr, fn) {
                     _a.label = 3;
                 case 3:
                     if (res === false) {
-                        return [3 /*break*/, 6];
+                        return [2 /*return*/, false];
                     }
                     return [4 /*yield*/, yieldToBrowser()];
                 case 4:
@@ -62,7 +68,7 @@ export default function executeSlowly(arr, fn) {
                 case 5:
                     i++;
                     return [3 /*break*/, 1];
-                case 6: return [2 /*return*/];
+                case 6: return [2 /*return*/, true];
             }
         });
     });

package/dist/fn/browser/yieldToBrowser.d.ts

@@ -1 +1,13 @@
+/**
+ * Yields execution to the browser to allow it to process pending UI updates.
+ * Uses `window.scheduler.yield()` if available, otherwise falls back to `requestAnimationFrame`.
+ * @method   yieldToBrowser
+ * @global
+ * @example
+ * ``` javascript
+ * await bbn.fn.yieldToBrowser();
+ * ```
+ * @memberof bbn.fn
+ * @returns  {Promise}
+ */
 export default function yieldToBrowser(): Promise<void>;

package/dist/fn/browser/yieldToBrowser.js

@@ -34,20 +34,33 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+/**
+ * Yields execution to the browser to allow it to process pending UI updates.
+ * Uses `window.scheduler.yield()` if available, otherwise falls back to `requestAnimationFrame`.
+ * @method   yieldToBrowser
+ * @global
+ * @example
+ * ``` javascript
+ * await bbn.fn.yieldToBrowser();
+ * ```
+ * @memberof bbn.fn
+ * @returns  {Promise}
+ */
 export default function yieldToBrowser() {
     return __awaiter(this, void 0, void 0, function () {
-        return __generator(this, function (_a) {
-            switch (_a.label) {
+        var _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
                 case 0:
-                    if (!('scheduler' in window)) return [3 /*break*/, 2];
+                    if (!((_a = window.scheduler) === null || _a === void 0 ? void 0 : _a.yield)) return [3 /*break*/, 2];
                     return [4 /*yield*/, window.scheduler.yield()];
                 case 1:
-                    _a.sent(); // cooperative yield
+                    _b.sent(); // cooperative yield
                     return [3 /*break*/, 4];
                 case 2: return [4 /*yield*/, new Promise(requestAnimationFrame)];
                 case 3:
-                    _a.sent();
-                    _a.label = 4;
+                    _b.sent();
+                    _b.label = 4;
                 case 4: return [2 /*return*/];
             }
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bbn/bbn",
-  "version": "1.0.424",
+  "version": "1.0.426",
   "description": "Javascript toolkit",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",