@dr.pogodin/js-utils 0.0.7 → 0.0.8

package/README.md

@@ -33,10 +33,6 @@ The library currently exports (links below lead to [React Utils] docs,
 but the same stuff can be imported from this `@dr.pogodin/js-utils`,
 and used in the same way):
 
-[Barrier]: https://dr.pogodin.studio/docs/react-utils/docs/api/classes/Barrier
-[Promise]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
-[timer]: https://dr.pogodin.studio/docs/react-utils/docs/api/utils/time#timer
-
 ### Constants
 - [SEC_MS](https://dr.pogodin.studio/docs/react-utils/docs/api/utils/time#sec_ms)
   — One second expressed in milliseconds.
@@ -50,8 +46,8 @@ and used in the same way):
   — One year expressed in milliseconds.
 
 ### Functions
-- [timer]
-  — Creates a [Barrier] which resolves after the specified timeout.
+- [timer()] — Creates a [Barrier] which resolves after the specified timeout.
+- [withRetries()] — Attempts a given action multiple times until its succeeds.
 
 ### Classes
 - [Barrier] — A [Promise] with **resolve()** and **reject()** exposed as
@@ -60,5 +56,12 @@ and used in the same way):
   — Simple listeneable data emitter.
 - [Semaphore](https://dr.pogodin.studio/docs/react-utils/docs/api/classes/Semaphore)
   — Synchronization primitive.
-- `Timer` — The core implementation of [timer] functionality, allowing
+- `Timer` — The core implementation of [timer()] functionality, allowing
   to create further customized timer objects. _To be documented_.
+
+<!-- References -->
+
+[Barrier]: https://dr.pogodin.studio/docs/react-utils/docs/api/classes/Barrier
+[Promise]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
+[timer()]: https://dr.pogodin.studio/docs/react-utils/docs/api/utils/time#timer
+[withRetries()]: https://dr.pogodin.studio/docs/react-utils/docs/api/functions/withretries

package/build/index.d.ts

@@ -2,3 +2,4 @@ export { default as Barrier } from './Barrier';
 export { default as Emitter } from './Emitter';
 export { default as Semaphore } from './Semaphore';
 export * from './time';
+export { default as withRetries } from './withRetries';

package/build/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Semaphore = exports.Emitter = exports.Barrier = void 0;
+exports.withRetries = exports.Semaphore = exports.Emitter = exports.Barrier = void 0;
 var Barrier_1 = require("./Barrier");
 Object.defineProperty(exports, "Barrier", { enumerable: true, get: function () { return __importDefault(Barrier_1).default; } });
 var Emitter_1 = require("./Emitter");
@@ -25,3 +25,5 @@ Object.defineProperty(exports, "Emitter", { enumerable: true, get: function () {
 var Semaphore_1 = require("./Semaphore");
 Object.defineProperty(exports, "Semaphore", { enumerable: true, get: function () { return __importDefault(Semaphore_1).default; } });
 __exportStar(require("./time"), exports);
+var withRetries_1 = require("./withRetries");
+Object.defineProperty(exports, "withRetries", { enumerable: true, get: function () { return __importDefault(withRetries_1).default; } });

package/build/withRetries.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Attempts to perform the given async `action` up to `maxRetries` times with
+ * the specified `interval`, stopping at the first successful (non-throwing)
+ * execution.
+ * @param action
+ * @param maxRetries Optional. The maximum number of re-tries. Defaults 3.
+ * @param interval Optional. The interval between re-tries (in milliseconds).
+ *  Defaults to 300ms.
+ * @returns Resolves to the result of the successful `action` execution;
+ *  or rejects with the error from the last faileda attempt.
+ */
+export default function withRetries(action: () => unknown, maxRetries?: number, interval?: number): Promise<any>;

package/build/withRetries.js

@@ -0,0 +1,42 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const time_1 = require("./time");
+/**
+ * Attempts to perform the given async `action` up to `maxRetries` times with
+ * the specified `interval`, stopping at the first successful (non-throwing)
+ * execution.
+ * @param action
+ * @param maxRetries Optional. The maximum number of re-tries. Defaults 3.
+ * @param interval Optional. The interval between re-tries (in milliseconds).
+ *  Defaults to 300ms.
+ * @returns Resolves to the result of the successful `action` execution;
+ *  or rejects with the error from the last faileda attempt.
+ */
+function withRetries(action, maxRetries = 3, interval = 300) {
+    return __awaiter(this, void 0, void 0, function* () {
+        /* eslint-disable no-await-in-loop */
+        for (let n = 1;; ++n) {
+            try {
+                const res = action();
+                return res instanceof Promise ? yield res : res;
+            }
+            catch (error) {
+                if (n < maxRetries)
+                    yield (0, time_1.timer)(interval);
+                else
+                    throw error;
+            }
+        }
+        /* eslint-enable no-await-in-loop */
+    });
+}
+exports.default = withRetries;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dr.pogodin/js-utils",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "description": "Collection of JavaScript (TypeScript) utilities.",
   "main": "build/index",
   "react-native": "src/index",
@@ -31,14 +31,14 @@
   },
   "homepage": "https://github.com/birdofpreyru/js-utils#readme",
   "devDependencies": {
-    "@babel/core": "^7.23.7",
-    "@babel/preset-env": "^7.23.8",
+    "@babel/core": "^7.23.9",
+    "@babel/preset-env": "^7.23.9",
     "@babel/preset-typescript": "^7.23.3",
     "@tsconfig/recommended": "^1.0.3",
     "@tsd/typescript": "^5.3.3",
-    "@types/jest": "^29.5.11",
-    "@typescript-eslint/eslint-plugin": "^6.19.0",
-    "@typescript-eslint/parser": "^6.19.0",
+    "@types/jest": "^29.5.12",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
     "babel-jest": "^29.7.0",
     "eslint": "^8.56.0",
     "eslint-config-airbnb-base": "^15.0.0",

package/src/index.ts

@@ -2,3 +2,4 @@ export { default as Barrier } from './Barrier';
 export { default as Emitter } from './Emitter';
 export { default as Semaphore } from './Semaphore';
 export * from './time';
+export { default as withRetries } from './withRetries';

package/src/withRetries.ts

@@ -0,0 +1,30 @@
+import { timer } from './time';
+
+/**
+ * Attempts to perform the given async `action` up to `maxRetries` times with
+ * the specified `interval`, stopping at the first successful (non-throwing)
+ * execution.
+ * @param action
+ * @param maxRetries Optional. The maximum number of re-tries. Defaults 3.
+ * @param interval Optional. The interval between re-tries (in milliseconds).
+ *  Defaults to 300ms.
+ * @returns Resolves to the result of the successful `action` execution;
+ *  or rejects with the error from the last faileda attempt.
+ */
+export default async function withRetries(
+  action: () => unknown,
+  maxRetries = 3,
+  interval = 300,
+) {
+  /* eslint-disable no-await-in-loop */
+  for (let n = 1; ; ++n) {
+    try {
+      const res = action();
+      return res instanceof Promise ? await res : res;
+    } catch (error) {
+      if (n < maxRetries) await timer(interval);
+      else throw error;
+    }
+  }
+  /* eslint-enable no-await-in-loop */
+}