@dr.pogodin/js-utils 0.0.6 → 0.0.8

package/README.md

@@ -22,8 +22,8 @@ very well documented as such.
 
 Yeah, the source code will be written in TypeScript, and for the library
 version released to NPM it will be also compiled into plain JavaScript.
-Consumers of that NPM package thus will have access to both TS (`/ts` folder)
-and JS (`/js` folder) version of the library.
+Consumers of that NPM package thus will have access to both TS (`/src` folder)
+and JS (`/build` folder) version of the library.
 
 [![Sponsor](https://raw.githubusercontent.com/birdofpreyru/js-utils/master/.README/sponsor.svg)](https://github.com/sponsors/birdofpreyru)
 
@@ -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/Emitter.js

@@ -31,7 +31,7 @@ class Emitter {
      * @param args
      */
     emit(...args) {
-        const { p_listeners: listeners } = this;
+        const listeners = this.p_listeners.slice();
         for (let i = 0; i < listeners.length; ++i) {
             listeners[i](...args);
         }

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/time.d.ts

@@ -1,9 +1,9 @@
 import Barrier, { type Executor } from './Barrier';
 export declare const SEC_MS = 1000;
-export declare const MIN_MS: number;
-export declare const HOUR_MS: number;
-export declare const DAY_MS: number;
-export declare const YEAR_MS: number;
+export declare const MIN_MS = 60000;
+export declare const HOUR_MS = 3600000;
+export declare const DAY_MS = 86400000;
+export declare const YEAR_MS = 31536000000;
 export declare class Timer<T> extends Barrier<void, T> {
     private p_abort;
     private p_timeout?;

package/build/time.js

@@ -5,11 +5,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.timer = exports.Timer = exports.YEAR_MS = exports.DAY_MS = exports.HOUR_MS = exports.MIN_MS = exports.SEC_MS = void 0;
 const Barrier_1 = __importDefault(require("./Barrier"));
+// This is not very elegant, but as of now TypeScript does not support type
+// arithmetic, thus we can't have constants assigned like `MIN_MS = 60 * SEC_MS`
+// and have the result type to be 60000 (number literal), it would be just
+// the generic number type.
 exports.SEC_MS = 1000;
-exports.MIN_MS = 60 * exports.SEC_MS;
-exports.HOUR_MS = 60 * exports.MIN_MS;
-exports.DAY_MS = 24 * exports.HOUR_MS;
-exports.YEAR_MS = 365 * exports.DAY_MS;
+exports.MIN_MS = 60000; // 60 * SEC_MS
+exports.HOUR_MS = 3600000; // 60 * MIN_MS
+exports.DAY_MS = 86400000; // 24 * HOUR_MS
+exports.YEAR_MS = 31536000000; // 365 * DAY_MS
 // TODO: Ok, as we have ended up with a Timer class, mostly to achieve a good
 // TypeScript typing for timer() function, it makes sense to expose the class
 // from the library as well, and it should be documented later.

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/jest.config-types.js

@@ -0,0 +1,4 @@
+module.exports = {
+  runner: 'jest-runner-tsd',
+  testMatch: ['**/__tests__/ts-types/**'],
+};

package/jest.config.js

@@ -1,4 +1,7 @@
 module.exports = {
   collectCoverage: true,
   coverageDirectory: '__coverage__',
+  testPathIgnorePatterns: [
+    '/__tests__/ts-types/',
+  ],
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dr.pogodin/js-utils",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "Collection of JavaScript (TypeScript) utilities.",
   "main": "build/index",
   "react-native": "src/index",
@@ -8,9 +8,11 @@
   "types": "build/index.d.ts",
   "scripts": {
     "build": "rimraf build && tsc",
-    "jest": "jest --config jest.config.js",
+    "jest": "npm run jest:types && npm run jest:logic",
+    "jest:logic": "jest --config jest.config.js",
+    "jest:types": "jest --config jest.config-types.js",
     "lint": "eslint . --ext .js,.ts",
-    "test": "npm run build && npm run lint && npm run typecheck && npm run jest",
+    "test": "npm run lint && npm run typecheck && npm run jest",
     "typecheck": "tsc --noEmit && tsc --project __tests__/tsconfig.json"
   },
   "repository": {
@@ -29,21 +31,24 @@
   },
   "homepage": "https://github.com/birdofpreyru/js-utils#readme",
   "devDependencies": {
-    "@babel/core": "^7.22.5",
-    "@babel/preset-env": "^7.22.5",
-    "@babel/preset-typescript": "^7.22.5",
-    "@tsconfig/recommended": "^1.0.2",
-    "@types/jest": "^29.5.2",
-    "@typescript-eslint/eslint-plugin": "^5.60.0",
-    "@typescript-eslint/parser": "^5.60.0",
-    "babel-jest": "^29.5.0",
-    "eslint": "^8.43.0",
+    "@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.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",
-    "eslint-config-airbnb-typescript": "^17.0.0",
-    "eslint-import-resolver-typescript": "^3.5.5",
-    "eslint-plugin-import": "^2.27.5",
-    "jest": "^29.5.0",
-    "rimraf": "^5.0.1",
-    "typescript": "^5.1.3"
+    "eslint-config-airbnb-typescript": "^17.1.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-import": "^2.29.1",
+    "jest": "^29.7.0",
+    "jest-runner-tsd": "^6.0.0",
+    "rimraf": "^5.0.5",
+    "tsd-lite": "^0.8.2",
+    "typescript": "^5.3.3"
   }
 }

package/src/Emitter.ts

@@ -33,7 +33,7 @@ export default class Emitter<T extends unknown[] = unknown[]> {
    * @param args
    */
   emit(...args: T) {
-    const { p_listeners: listeners } = this;
+    const listeners = this.p_listeners.slice();
     for (let i = 0; i < listeners.length; ++i) {
       listeners[i](...args);
     }

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/time.ts

@@ -1,10 +1,14 @@
 import Barrier, { type Executor } from './Barrier';
 
+// This is not very elegant, but as of now TypeScript does not support type
+// arithmetic, thus we can't have constants assigned like `MIN_MS = 60 * SEC_MS`
+// and have the result type to be 60000 (number literal), it would be just
+// the generic number type.
 export const SEC_MS = 1000;
-export const MIN_MS = 60 * SEC_MS;
-export const HOUR_MS = 60 * MIN_MS;
-export const DAY_MS = 24 * HOUR_MS;
-export const YEAR_MS = 365 * DAY_MS;
+export const MIN_MS = 60000; // 60 * SEC_MS
+export const HOUR_MS = 3600000; // 60 * MIN_MS
+export const DAY_MS = 86400000; // 24 * HOUR_MS
+export const YEAR_MS = 31536000000; // 365 * DAY_MS
 
 // TODO: Ok, as we have ended up with a Timer class, mostly to achieve a good
 // TypeScript typing for timer() function, it makes sense to expose the class

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 */
+}