@ribbon-studios/js-utils 1.2.0 → 1.3.0

package/CONTRIBUTING.md

@@ -5,7 +5,7 @@ Then this is the perfect place for you!
 
 ## Prerequisites
 
-- NodeJS 18
+- NodeJS 22
 
 ## Setting Up Locally
 

package/README.md

@@ -19,6 +19,7 @@ Collection of generic javascript utilities curated by the Rainbow Cafe~
   - [`assert`](#assert)
     - [`assert.defined`](#assertdefined)
   - [`never`](#never)
+  - [`retry`](#retry)
 - [Fetch](#fetch)
   - [`rfetch`](#rfetch)
     - [`rfetch.get`](#rfetchget)
@@ -103,6 +104,18 @@ const promise = never(); // Returns a promise that never resolves
 const promise = never(Promise.resolve('hello')); // Returns a promise that never resolves
 ```
 
+### `retry`
+
+Retries a function `n` times until it resolves successfully.
+This can be useful for requests that tend to be flaky.
+
+```tsx
+import { retry } from '@ribbon-studios/js-utils';
+
+// Returns a promise that resolves when the request is successful or fails after its exceeded that maximum attempts.
+const promise = retry(() => getMaps(), 5);
+```
+
 ## Fetch
 
 ### `rfetch`
@@ -202,7 +215,7 @@ await rfetch.remove<MyExpectedResponse>('https://ribbonstudios.com');
 [coveralls-url]: https://coveralls.io/github/ribbon-studios/js-utils?branch=main
 [code-style-image]: https://img.shields.io/badge/code%20style-prettier-ff69b4.svg
 [code-style-url]: https://prettier.io
-[maintainability-image]: https://img.shields.io/codeclimate/maintainability/ribbon-studios/refreshly
-[maintainability-url]: https://codeclimate.com/github/ribbon-studios/refreshly/maintainability
+[maintainability-image]: https://img.shields.io/codeclimate/maintainability/ribbon-studios/js-utils
+[maintainability-url]: https://codeclimate.com/github/ribbon-studios/js-utils/maintainability
 [semantic-release-url]: https://github.com/semantic-release/semantic-release
 [semantic-release-image]: https://img.shields.io/badge/%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079

package/dist/index.cjs

@@ -2,8 +2,7 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 async function assert(p, predicate, message) {
   const value = await p;
-  if (predicate(value))
-    return value;
+  if (predicate(value)) return value;
   throw new Error(message ?? "Value does not satisfy predicate");
 }
 ((assert2) => {
@@ -27,11 +26,21 @@ async function delay(promise, ms) {
   delay2.fallback = fallback;
 })(delay || (delay = {}));
 async function never(p) {
-  if (p)
-    console.warn(`Promise is being called via "never", please ensure this doesn't get deployed!`, p);
+  if (p) console.warn(`Promise is being called via "never", please ensure this doesn't get deployed!`, p);
   return new Promise(() => {
   });
 }
+async function retry(fn, n) {
+  let attempts = 0;
+  while (true) {
+    try {
+      return await fn();
+    } catch (error) {
+      if (++attempts < n) continue;
+      throw error;
+    }
+  }
+}
 async function rfetch(url, options) {
   var _a, _b;
   const { params, headers, body, ...internalOptions } = {
@@ -112,4 +121,5 @@ async function rfetch(url, options) {
 exports.assert = assert;
 exports.delay = delay;
 exports.never = never;
+exports.retry = retry;
 exports.rfetch = rfetch;

package/dist/index.js

@@ -1,7 +1,6 @@
 async function assert(p, predicate, message) {
   const value = await p;
-  if (predicate(value))
-    return value;
+  if (predicate(value)) return value;
   throw new Error(message ?? "Value does not satisfy predicate");
 }
 ((assert2) => {
@@ -25,11 +24,21 @@ async function delay(promise, ms) {
   delay2.fallback = fallback;
 })(delay || (delay = {}));
 async function never(p) {
-  if (p)
-    console.warn(`Promise is being called via "never", please ensure this doesn't get deployed!`, p);
+  if (p) console.warn(`Promise is being called via "never", please ensure this doesn't get deployed!`, p);
   return new Promise(() => {
   });
 }
+async function retry(fn, n) {
+  let attempts = 0;
+  while (true) {
+    try {
+      return await fn();
+    } catch (error) {
+      if (++attempts < n) continue;
+      throw error;
+    }
+  }
+}
 async function rfetch(url, options) {
   var _a, _b;
   const { params, headers, body, ...internalOptions } = {
@@ -111,5 +120,6 @@ export {
   assert,
   delay,
   never,
+  retry,
   rfetch
 };

package/dist/promises/__tests__/retry.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/promises/index.d.ts

@@ -1,3 +1,4 @@
 export * from './assert';
 export * from './delay';
 export * from './never';
+export * from './retry';

package/dist/promises/retry.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Attempts a request {@link n} times until it resolves.
+ *
+ * @param fn The function to invoke.
+ * @param n The maximum number of attempts
+ * @returns A resolved promise if it succeeds or the rejected promise if it exceeds {@link n}
+ */
+export declare function retry<T>(fn: () => Promise<T>, n: number): Promise<T>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ribbon-studios/js-utils",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Collection of generic javascript utilities curated by the Rainbow Cafe~",
   "type": "module",
   "source": "src/*.ts",
@@ -28,20 +28,23 @@
     "build": "rm -rf dist && vite build"
   },
   "devDependencies": {
-    "@types/node": "^20.11.20",
-    "@typescript-eslint/eslint-plugin": "^7.0.2",
-    "@typescript-eslint/parser": "^7.0.2",
-    "@vitest/coverage-v8": "^1.3.1",
-    "chance": "^1.1.11",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-unused-imports": "^3.1.0",
-    "happy-dom": "^13.5.0",
-    "typescript": "^5.3.3",
-    "vite": "^5.1.4",
-    "vite-plugin-dts": "^3.7.3",
-    "vite-plugin-lib-types": "^3.0.9",
-    "vitest": "^1.3.1",
+    "@eslint/js": "^9.22.0",
+    "@types/chance": "^1.1.6",
+    "@types/node": "^22.13.10",
+    "@typescript-eslint/eslint-plugin": "^8.26.0",
+    "@typescript-eslint/parser": "^8.26.0",
+    "@vitest/coverage-v8": "^3.0.8",
+    "ajv": "^8.17.1",
+    "chance": "^1.1.12",
+    "eslint-plugin-unused-imports": "^4.1.4",
+    "happy-dom": "^17.4.1",
+    "jiti": "^2.4.2",
+    "typescript": "^5.8.2",
+    "typescript-eslint": "^8.26.0",
+    "vite": "^6.2.1",
+    "vite-plugin-dts": "^4.5.3",
+    "vite-plugin-lib-types": "^3.1.2",
+    "vitest": "^3.0.8",
     "vitest-dom": "^0.1.1"
   },
   "publishConfig": {