get-promisable-result 2.0.0 → 2.1.0

package/README.md

@@ -43,16 +43,17 @@ getPromisableResult(
 
 ### Options
 
-| Parameter      | Type          | Default | Description                                                         |
-| -------------- | ------------- | ------- | ------------------------------------------------------------------- |
-| retries        | number        | 10      | number of retries that will be performed before the promise rejects |
-| delay          | number        | 10      | delay between the retries                                           |
-| shouldReject   | boolean       | true    | indicates if the promise should be rejected when the number of retries reached the limit. If this parameter is set to `false` and the number of retries is reached the Promise will be resolved with the last value returned by `getResultFunction` |
-| rejectMessage  | string        | \*\*    | custom error message. It can contain the substring `{{ retries }}` and it will be replaced with the number of `retries` |
+| Parameter      | Type          | Default   | Description                                                         |
+| -------------- | ------------- | --------- | ------------------------------------------------------------------- |
+| retries        | number        | 10        | number of retries that will be performed before the promise rejects |
+| delay          | number        | 10        | delay between the retries                                           |
+| shouldReject   | boolean       | true      | indicates if the promise should be rejected when the number of retries reached the limit. If this parameter is set to `false` and the number of retries is reached the Promise will be resolved with the last value returned by `getResultFunction` |
+| rejectMessage  | string        | \*\*      | custom error message. It can contain the substring `{{ retries }}` and it will be replaced with the number of `retries` |
+| signal         | AbortSignal   | undefined | An [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) object that allows you abort the promise before it is fullfilled if required via an [AbortController instance](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) |
 
 >\*\* The default `rejectMessage` will be `Could not get the result after {{ retries }} retries`
 
-## Example
+## Examples
 
 Querying a DOM element that is rendered asynchronously with a custom `retries`, `delay` and `rejectMessage`
 
@@ -73,4 +74,36 @@ getPromisableResult(
     // Do something if the promise is rejected
     // My element could not be retrieved after 50 retries
   });
+```
+
+Querying a DOM element that is rendered asynchronously with the ability to abort the query
+
+```typescript
+const controller = new AbortController();
+const { signal } = controller;
+
+getPromisableResult(
+  () => document.getElementById('my-element'),
+  (element) => element !== null,
+  {
+    retries: 2000,
+    delay: 100,
+    rejectMessage: 'My element could not be retrieved after {{ restries }} retries',
+    signal
+  }
+)
+  .then((element) => {
+    // Do something with the element
+  })
+  .catch((error) => {
+    if (error.name === 'AbortError') {
+      // Do something if the promise was aborted on purpose
+    } else {
+      // Do something if the promise is rejected
+      // My element could not be retrieved after 50 retries
+    }
+  });
+
+// Abort the promise on purpose
+controller.abort();
 ```

package/dist/esm/index.d.ts

@@ -3,6 +3,7 @@ interface PromisableOptions {
     delay?: number;
     shouldReject?: boolean;
     rejectMessage?: string;
+    signal?: AbortSignal;
 }
 declare const getPromisableResult: <T>(getResultFunction: () => T, checkResult: (result: T) => boolean, options?: PromisableOptions) => Promise<T>;
 

package/dist/esm/index.js

@@ -1 +1 @@
-const e=10,r=10,t=(t,s,o={})=>{var n;const{retries:l=e,delay:c=r,shouldReject:i=!0}=o,u=null!==(n=o.rejectMessage)&&void 0!==n?n:"Could not get the result after {{ retries }} retries";return new Promise((e,r)=>{let o=0;const n=()=>{const a=t();s(a)?e(a):(o++,o<l?setTimeout(n,c):i?r(new Error(u.replace(/\{\{\s*retries\s*\}\}/g,`${l}`))):e(a))};n()})};export{t as getPromisableResult};
+const e=10,r=10,t=(t,s,o={})=>{var n;const{retries:l=e,delay:a=r,shouldReject:i=!0,signal:c}=o,u=null!==(n=o.rejectMessage)&&void 0!==n?n:"Could not get the result after {{ retries }} retries";return new Promise((e,r)=>{let o=0;const n=()=>{const c=t();s(c)?e(c):(o++,o<l?setTimeout(n,a):i?r(new Error(u.replace(/\{\{\s*retries\s*\}\}/g,`${l}`))):e(c))};null==c||c.throwIfAborted(),null==c||c.addEventListener("abort",()=>{r(c.reason)},{once:!0}),n()})};export{t as getPromisableResult};

package/dist/index.d.ts

@@ -3,6 +3,7 @@ interface PromisableOptions {
     delay?: number;
     shouldReject?: boolean;
     rejectMessage?: string;
+    signal?: AbortSignal;
 }
 declare const getPromisableResult: <T>(getResultFunction: () => T, checkResult: (result: T) => boolean, options?: PromisableOptions) => Promise<T>;
 

package/dist/index.js

@@ -1 +1 @@
-"use strict";const e=10,t=10;exports.getPromisableResult=(r,s,o={})=>{var l;const{retries:i=e,delay:n=t,shouldReject:c=!0}=o,u=null!==(l=o.rejectMessage)&&void 0!==l?l:"Could not get the result after {{ retries }} retries";return new Promise((e,t)=>{let o=0;const l=()=>{const a=r();s(a)?e(a):(o++,o<i?setTimeout(l,n):c?t(new Error(u.replace(/\{\{\s*retries\s*\}\}/g,`${i}`))):e(a))};l()})};
+"use strict";const e=10,t=10;exports.getPromisableResult=(r,s,o={})=>{var n;const{retries:l=e,delay:i=t,shouldReject:a=!0,signal:u}=o,c=null!==(n=o.rejectMessage)&&void 0!==n?n:"Could not get the result after {{ retries }} retries";return new Promise((e,t)=>{let o=0;const n=()=>{const u=r();s(u)?e(u):(o++,o<l?setTimeout(n,i):a?t(new Error(c.replace(/\{\{\s*retries\s*\}\}/g,`${l}`))):e(u))};null==u||u.throwIfAborted(),null==u||u.addEventListener("abort",()=>{t(u.reason)},{once:!0}),n()})};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "get-promisable-result",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "A very small JavaScript utility to check and retry a function a limited number of times abstracting it in a Promise",
   "keywords": [
     "promise",
@@ -13,6 +13,7 @@
     "retry",
     "check-and-retry"
   ],
+  "type": "module",
   "main": "dist/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/index.d.ts",
@@ -38,7 +39,7 @@
     "url": "git+https://github.com/elchininet/get-promisable-result"
   },
   "scripts": {
-    "build": "rollup --config rollup.config.js --bundleConfigAsCjs",
+    "build": "rollup --config rollup.config.mjs",
     "test:ts": "tsc --noEmit",
     "test:lint": "eslint \"src/**/*.ts\" \"tests/**/*.ts\"",
     "test:unit": "jest --clearCache && jest --verbose --coverage",
@@ -54,21 +55,17 @@
     "@rollup/plugin-typescript": "^12.3.0",
     "@types/eslint": "^9.6.1",
     "@types/jest": "^30.0.0",
-    "@types/node": "^25.5.0",
-    "eslint": "^10.1.0",
-    "globals": "^17.4.0",
-    "jest": "^30.3.0",
-    "rollup": "4.60.0",
-    "rollup-plugin-dts": "^6.4.1",
+    "@types/node": "^26.2.0",
+    "eslint": "^10.9.0",
+    "globals": "^17.11.0",
+    "jest": "^30.4.2",
+    "rollup": "4.62.5",
+    "rollup-plugin-dts": "^6.5.1",
     "rollup-plugin-tsconfig-paths": "^1.5.2",
-    "ts-jest": "^29.4.6",
+    "ts-jest": "^29.4.12",
     "tslib": "^2.7.0",
-    "typescript": "^6.0.2",
-    "typescript-eslint": "^8.57.2"
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.67.0"
   },
-  "pnpm": {
-    "overrides": {
-      "@isaacs/brace-expansion@<=5.0.0": ">=5.0.1"
-    }
-  }
+  "packageManager": "pnpm@11.15.0"
 }