@ezez/utils 4.1.0 → 4.3.0

package/src/get.spec.ts

@@ -48,7 +48,6 @@ describe("get", () => {
         const value = get(testObject, "product.name");
         value.must.equal("abc");
 
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
         const _value = _get(testObject, "product.name");
         value.must.equal(_value);
     });
@@ -59,7 +58,6 @@ describe("get", () => {
         const name = get(testObject, "product[name]");
         (name === undefined).must.be.true();
 
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
         const _name = _get(testObject, "product[name]"); // deep value
         _name.must.equal("abc");
 
@@ -74,7 +72,7 @@ describe("get", () => {
         const value = get(testObject, "product.something");
         (value === undefined).must.be.true();
 
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        // eslint-disable-next-line @typescript-eslint/no-confusing-void-expression
         const _value = _get(testObject, "product.something");
         (_value === undefined).must.be.true();
     });
@@ -83,7 +81,6 @@ describe("get", () => {
         const value = get(testObject, "product.something", 3);
         value.must.equal(3);
 
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
         const _value = _get(testObject, "product.something", 3);
         _value.must.equal(3);
     });
@@ -92,7 +89,6 @@ describe("get", () => {
         const value = get(testObject, "product.value", 3);
         (value === undefined).must.be.true();
 
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
         const _value = _get(testObject, "product.value", 3);
         _value.must.equal(3);
     });
@@ -101,7 +97,6 @@ describe("get", () => {
         const value = get(testObject, "product.empty", 3);
         (value === null).must.be.true();
 
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
         const _value = _get(testObject, "product.empty", 3);
         (_value === null).must.be.true();
     });
@@ -110,7 +105,6 @@ describe("get", () => {
         const value = get(testObject, "product.notANumber", 3);
         value.must.be.nan();
 
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
         const _value = _get(testObject, "product.notANumber", 3);
         _value.must.be.nan();
     });
@@ -119,7 +113,6 @@ describe("get", () => {
         const value = get(testObject, "product.object");
         value.must.equal(otherObject);
 
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
         const _value = _get(testObject, "product.object");
         _value.must.equal(otherObject);
     });
@@ -144,7 +137,6 @@ describe("get", () => {
         const value = get(NaN, "product.object", 3);
         value.must.equal(3);
 
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
         const _value = _get(NaN, "product.object", 3);
         _value.must.equal(3);
     });

package/src/index.ts

@@ -32,11 +32,13 @@ export * from "./occurrences.js";
 export * from "./omit.js";
 export * from "./pick.js";
 export * from "./pull.js";
+export * from "./race.js";
 export * from "./remove.js";
 export * from "./removeCommonProperties.js";
 export * from "./replace.js";
 export * from "./replaceDeep.js";
 export * from "./rethrow.js";
+export * from "./retry.js";
 export * from "./round.js";
 export * from "./safe.js";
 export * from "./sample.js";

package/src/mapValues.spec.ts

@@ -165,9 +165,8 @@ describe("mapValues", () => {
 
         const res = mapValues(array, (val) => (typeof val === "string" ? REMOVE : val));
 
-        // eslint-disable-next-line no-sparse-arrays
         res.must.eql([
-            1, , 1, , 69,
+            1, , 1, , 69, // eslint-disable-line no-sparse-arrays
         ]);
         ("0" in res).must.be.true();
         ("1" in res).must.be.false();

package/src/race.ts

@@ -0,0 +1,29 @@
+/**
+ * This function helps you timeout your promises while keeping the TS types right.
+ *
+ * @example await race(yourPromise, 1000); // resolves (or rejects) with the value of yourPromise or rejects with "Race: Timeout" message in a second
+ * @example
+ * ```
+ * type Data = { a: number };
+ * const myPromise = new Promise<Data>((resolve) => setTimeout(() => resolve({ a: 1 }), 2000));
+ * const { a } = await race(myPromise, 1000); // You're allowed to destructure the result with TS
+ *
+ * @param promise - Your promise
+ * @param timeout - Time in milliseconds to wait for the promise to resolve
+ * @param message - Error message to use when the timeout is reached
+ */
+const race = <T>(promise: Promise<T>, timeout: number, message = "Race: Timeout"): Promise<T> => {
+    return Promise.race([
+        promise, new Promise<T>((_, reject) => {
+            setTimeout(() => {
+                reject(new Error(message));
+            }, timeout);
+        }),
+    ]);
+};
+
+export {
+    race,
+};
+
+// TODO unit tests

package/src/retry.ts

@@ -0,0 +1,53 @@
+import { wait } from "./wait";
+
+type EarlyBreaker = (error: unknown, count: number) => boolean;
+type Options = {
+    /**
+     * Maximum number of retries. If not specified, the function will retry indefinitely.
+     * 0 means the function will be executed once (no retries)
+     * 1 means the function will be executed twice (1 retry), etc.
+     */
+    maxRetries?: number;
+    /**
+     * Function to determine if the function should be retried, based on the error that was thrown and the number of retries so far.
+     */
+    earlyBreak?: EarlyBreaker;
+    /**
+     * Number of milliseconds to wait between retries.
+     */
+    waitBetween?: number | ((retriesCount: number) => number);
+};
+
+/**
+ * Execute a function until it succeeds. Limit the retries, wait between retries, control when to stop trying early.
+ * @param fn - The function to execute.
+ * @param options - Options controlling the behavior of the function.
+ */
+const retry = async <T>(fn: () => Promise<T>, options?: Options): Promise<T> => {
+    const maxRetries = options?.maxRetries ?? Infinity;
+    const earlyBreak = options?.earlyBreak ?? (() => false);
+    const waitBetween = options?.waitBetween ?? 0;
+
+    let retriesCount = 0;
+
+    while (true) { // eslint-disable-line @typescript-eslint/no-unnecessary-condition, no-constant-condition
+        try {
+            return await fn();
+        }
+        catch (e: unknown) {
+            if (retriesCount >= maxRetries || earlyBreak(e, retriesCount)) {
+                throw e; // eslint-disable-line @typescript-eslint/only-throw-error
+            }
+            retriesCount++;
+            if (waitBetween) {
+                await wait(typeof waitBetween === "function" ? waitBetween(retriesCount) : waitBetween);
+            }
+        }
+    }
+};
+
+export {
+    retry,
+};
+
+// TODO unit tests