@xylabs/retry 5.0.82 → 5.0.84

package/README.md

@@ -42,6 +42,8 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 function retry<T>(func, config?): Promise<T | undefined>;
 ```
 
+Retries an async function with exponential backoff until it completes or retries are exhausted.
+
 ## Type Parameters
 
 ### T
@@ -54,14 +56,20 @@ function retry<T>(func, config?): Promise<T | undefined>;
 
 () => `Promisable`\<`T` \| `undefined`\>
 
+The function to retry.
+
 ### config?
 
 [`RetryConfigWithComplete`](#../interfaces/RetryConfigWithComplete)\<`T`\>
 
+Optional retry configuration including backoff, interval, retries, and completion check.
+
 ## Returns
 
 `Promise`\<`T` \| `undefined`\>
 
+The result of the function, or undefined if all retries were exhausted.
+
 ### interfaces
 
   ### <a id="RetryConfig"></a>RetryConfig
@@ -70,6 +78,8 @@ function retry<T>(func, config?): Promise<T | undefined>;
 
 ***
 
+Configuration for retry behavior.
+
 ## Extended by
 
 - [`RetryConfigWithComplete`](#RetryConfigWithComplete)
@@ -82,6 +92,8 @@ function retry<T>(func, config?): Promise<T | undefined>;
 optional backoff: number;
 ```
 
+Multiplier applied to the interval after each retry. Defaults to 2.
+
 ***
 
 ### interval?
@@ -90,6 +102,8 @@ optional backoff: number;
 optional interval: number;
 ```
 
+Initial delay in milliseconds between retries. Defaults to 100.
+
 ***
 
 ### retries?
@@ -98,12 +112,16 @@ optional interval: number;
 optional retries: number;
 ```
 
+Maximum number of retry attempts. Defaults to 0 (no retries).
+
   ### <a id="RetryConfigWithComplete"></a>RetryConfigWithComplete
 
 [**@xylabs/retry**](#../README)
 
 ***
 
+Retry configuration extended with a custom completion check.
+
 ## Extends
 
 - [`RetryConfig`](#RetryConfig)
@@ -122,6 +140,8 @@ optional retries: number;
 optional backoff: number;
 ```
 
+Multiplier applied to the interval after each retry. Defaults to 2.
+
 ### Inherited from
 
 [`RetryConfig`](#RetryConfig).[`backoff`](RetryConfig.md#backoff)
@@ -134,6 +154,8 @@ optional backoff: number;
 optional interval: number;
 ```
 
+Initial delay in milliseconds between retries. Defaults to 100.
+
 ### Inherited from
 
 [`RetryConfig`](#RetryConfig).[`interval`](RetryConfig.md#interval)
@@ -146,6 +168,8 @@ optional interval: number;
 optional retries: number;
 ```
 
+Maximum number of retry attempts. Defaults to 0 (no retries).
+
 ### Inherited from
 
 [`RetryConfig`](#RetryConfig).[`retries`](RetryConfig.md#retries)
@@ -158,6 +182,8 @@ optional retries: number;
 optional complete: (result?) => boolean;
 ```
 
+Determines whether the result is considered complete. Defaults to checking for a defined value.
+
 ### Parameters
 
 #### result?

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/retry.ts"],"sourcesContent":["import { delay } from '@xylabs/delay'\nimport type { Promisable } from '@xylabs/promise'\n\nexport interface RetryConfig {\n  backoff?: number\n  interval?: number\n  retries?: number\n}\n\nexport interface RetryConfigWithComplete<T = unknown> extends RetryConfig {\n  complete?: (result?: T) => boolean\n}\n\nexport const retry = async <T = unknown>(func: () => Promisable<T | undefined>, config?: RetryConfigWithComplete<T>): Promise<T | undefined> => {\n  const {\n    complete = (value: T | undefined) => value !== undefined, retries = 0, interval = 100, backoff = 2,\n  } = config ?? {}\n  const result = await func()\n  if (complete(result)) {\n    return result\n  }\n  if (retries <= 0) {\n    return undefined\n  }\n  await delay(interval)\n  return retry(func, {\n    backoff, complete, interval: interval * backoff, retries: retries - 1,\n  })\n}\n"],"mappings":";AAAA,SAAS,aAAa;AAaf,IAAM,QAAQ,OAAoB,MAAuC,WAAgE;AAC9I,QAAM;AAAA,IACJ,WAAW,CAAC,UAAyB,UAAU;AAAA,IAAW,UAAU;AAAA,IAAG,WAAW;AAAA,IAAK,UAAU;AAAA,EACnG,IAAI,UAAU,CAAC;AACf,QAAM,SAAS,MAAM,KAAK;AAC1B,MAAI,SAAS,MAAM,GAAG;AACpB,WAAO;AAAA,EACT;AACA,MAAI,WAAW,GAAG;AAChB,WAAO;AAAA,EACT;AACA,QAAM,MAAM,QAAQ;AACpB,SAAO,MAAM,MAAM;AAAA,IACjB;AAAA,IAAS;AAAA,IAAU,UAAU,WAAW;AAAA,IAAS,SAAS,UAAU;AAAA,EACtE,CAAC;AACH;","names":[]}
+{"version":3,"sources":["../../src/retry.ts"],"sourcesContent":["import { delay } from '@xylabs/delay'\nimport type { Promisable } from '@xylabs/promise'\n\n/** Configuration for retry behavior. */\nexport interface RetryConfig {\n  /** Multiplier applied to the interval after each retry. Defaults to 2. */\n  backoff?: number\n  /** Initial delay in milliseconds between retries. Defaults to 100. */\n  interval?: number\n  /** Maximum number of retry attempts. Defaults to 0 (no retries). */\n  retries?: number\n}\n\n/** Retry configuration extended with a custom completion check. */\nexport interface RetryConfigWithComplete<T = unknown> extends RetryConfig {\n  /** Determines whether the result is considered complete. Defaults to checking for a defined value. */\n  complete?: (result?: T) => boolean\n}\n\n/**\n * Retries an async function with exponential backoff until it completes or retries are exhausted.\n * @param func - The function to retry.\n * @param config - Optional retry configuration including backoff, interval, retries, and completion check.\n * @returns The result of the function, or undefined if all retries were exhausted.\n */\nexport const retry = async <T = unknown>(func: () => Promisable<T | undefined>, config?: RetryConfigWithComplete<T>): Promise<T | undefined> => {\n  const {\n    complete = (value: T | undefined) => value !== undefined, retries = 0, interval = 100, backoff = 2,\n  } = config ?? {}\n  const result = await func()\n  if (complete(result)) {\n    return result\n  }\n  if (retries <= 0) {\n    return undefined\n  }\n  await delay(interval)\n  return retry(func, {\n    backoff, complete, interval: interval * backoff, retries: retries - 1,\n  })\n}\n"],"mappings":";AAAA,SAAS,aAAa;AAyBf,IAAM,QAAQ,OAAoB,MAAuC,WAAgE;AAC9I,QAAM;AAAA,IACJ,WAAW,CAAC,UAAyB,UAAU;AAAA,IAAW,UAAU;AAAA,IAAG,WAAW;AAAA,IAAK,UAAU;AAAA,EACnG,IAAI,UAAU,CAAC;AACf,QAAM,SAAS,MAAM,KAAK;AAC1B,MAAI,SAAS,MAAM,GAAG;AACpB,WAAO;AAAA,EACT;AACA,MAAI,WAAW,GAAG;AAChB,WAAO;AAAA,EACT;AACA,QAAM,MAAM,QAAQ;AACpB,SAAO,MAAM,MAAM;AAAA,IACjB;AAAA,IAAS;AAAA,IAAU,UAAU,WAAW;AAAA,IAAS,SAAS,UAAU;AAAA,EACtE,CAAC;AACH;","names":[]}

package/dist/neutral/retry.d.ts

@@ -1,11 +1,23 @@
 import type { Promisable } from '@xylabs/promise';
+/** Configuration for retry behavior. */
 export interface RetryConfig {
+    /** Multiplier applied to the interval after each retry. Defaults to 2. */
     backoff?: number;
+    /** Initial delay in milliseconds between retries. Defaults to 100. */
     interval?: number;
+    /** Maximum number of retry attempts. Defaults to 0 (no retries). */
     retries?: number;
 }
+/** Retry configuration extended with a custom completion check. */
 export interface RetryConfigWithComplete<T = unknown> extends RetryConfig {
+    /** Determines whether the result is considered complete. Defaults to checking for a defined value. */
     complete?: (result?: T) => boolean;
 }
+/**
+ * Retries an async function with exponential backoff until it completes or retries are exhausted.
+ * @param func - The function to retry.
+ * @param config - Optional retry configuration including backoff, interval, retries, and completion check.
+ * @returns The result of the function, or undefined if all retries were exhausted.
+ */
 export declare const retry: <T = unknown>(func: () => Promisable<T | undefined>, config?: RetryConfigWithComplete<T>) => Promise<T | undefined>;
 //# sourceMappingURL=retry.d.ts.map

package/dist/neutral/retry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"retry.d.ts","sourceRoot":"","sources":["../../src/retry.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,MAAM,WAAW,WAAW;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,uBAAuB,CAAC,CAAC,GAAG,OAAO,CAAE,SAAQ,WAAW;IACvE,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,OAAO,CAAA;CACnC;AAED,eAAO,MAAM,KAAK,GAAU,CAAC,GAAG,OAAO,EAAE,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,SAAS,CAAC,EAAE,SAAS,uBAAuB,CAAC,CAAC,CAAC,KAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAe1I,CAAA"}
+{"version":3,"file":"retry.d.ts","sourceRoot":"","sources":["../../src/retry.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,wCAAwC;AACxC,MAAM,WAAW,WAAW;IAC1B,0EAA0E;IAC1E,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,sEAAsE;IACtE,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,oEAAoE;IACpE,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,mEAAmE;AACnE,MAAM,WAAW,uBAAuB,CAAC,CAAC,GAAG,OAAO,CAAE,SAAQ,WAAW;IACvE,sGAAsG;IACtG,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,OAAO,CAAA;CACnC;AAED;;;;;GAKG;AACH,eAAO,MAAM,KAAK,GAAU,CAAC,GAAG,OAAO,EAAE,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,SAAS,CAAC,EAAE,SAAS,uBAAuB,CAAC,CAAC,CAAC,KAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAe1I,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/retry",
-  "version": "5.0.82",
+  "version": "5.0.84",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "delay",
@@ -42,12 +42,12 @@
     "!**/*.test.*"
   ],
   "dependencies": {
-    "@xylabs/delay": "~5.0.82",
-    "@xylabs/promise": "~5.0.82"
+    "@xylabs/delay": "~5.0.84",
+    "@xylabs/promise": "~5.0.84"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "~7.4.11",
-    "@xylabs/tsconfig": "~7.4.11",
+    "@xylabs/ts-scripts-yarn3": "~7.4.13",
+    "@xylabs/tsconfig": "~7.4.13",
     "typescript": "~5.9.3",
     "vitest": "^4.0.18"
   },