@xylabs/forget 4.0.3 → 4.0.5

package/dist/neutral/forget.d.ts

@@ -0,0 +1,12 @@
+export interface ForgetTimeoutConfig {
+    cancel: () => void;
+    delay: number;
+}
+export declare const ForgetPromise: {
+    readonly active: boolean;
+    activeForgets: number;
+    awaitInactive(interval?: number, timeout?: number): Promise<number>;
+    forget<T>(promise: Promise<T>, onComplete?: (result: [T | undefined, Error | undefined]) => void, config?: ForgetTimeoutConfig): void;
+};
+export declare const forget: <T>(promise: Promise<T>, onComplete?: (result: [T | undefined, Error | undefined]) => void, timeout?: ForgetTimeoutConfig) => void;
+//# sourceMappingURL=forget.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"forget.d.ts","sourceRoot":"","sources":["../../src/forget.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,IAAI,CAAA;IAClB,KAAK,EAAE,MAAM,CAAA;CACd;AAED,eAAO,MAAM,aAAa;;;+CAOsB,MAAM;WAmB7C,CAAC,WAAW,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,SAAS,EAAE,KAAK,GAAG,SAAS,CAAC,KAAK,IAAI,WAAW,mBAAmB;CA0C/H,CAAA;AAGD,eAAO,MAAM,MAAM,GAAI,CAAC,WAAW,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,SAAS,EAAE,KAAK,GAAG,SAAS,CAAC,KAAK,IAAI,YAAY,mBAAmB,SAE9I,CAAA"}

package/dist/neutral/index.d.ts

@@ -1,13 +1,2 @@
-interface ForgetTimeoutConfig {
-    cancel: () => void;
-    delay: number;
-}
-declare const ForgetPromise: {
-    readonly active: boolean;
-    activeForgets: number;
-    awaitInactive(interval?: number, timeout?: number): Promise<number>;
-    forget<T>(promise: Promise<T>, config?: ForgetTimeoutConfig): void;
-};
-declare const forget: (promise: Promise<unknown>, timeout?: ForgetTimeoutConfig) => void;
-
-export { ForgetPromise, forget };
+export { forget, ForgetPromise } from './forget.ts';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA"}

package/dist/neutral/index.mjs

@@ -23,16 +23,18 @@ var ForgetPromise = {
    * @param promise The promise to forget
    * @param config Configuration of forget settings
    */
-  forget(promise, config) {
+  forget(promise, onComplete, config) {
     let completed = false;
     this.activeForgets++;
     const promiseWrapper = async () => {
-      await promise.then(() => {
+      await promise.then((result) => {
         this.activeForgets--;
         completed = true;
-      }).catch(() => {
+        onComplete?.([result, void 0]);
+      }).catch((error) => {
         this.activeForgets--;
         completed = true;
+        onComplete?.([void 0, error]);
       });
     };
     const promises = [promiseWrapper()];
@@ -54,8 +56,8 @@ var ForgetPromise = {
     });
   }
 };
-var forget = (promise, timeout) => {
-  ForgetPromise.forget(promise, timeout);
+var forget = (promise, onComplete, timeout) => {
+  ForgetPromise.forget(promise, onComplete, timeout);
 };
 export {
   ForgetPromise,

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/forget.ts"],"sourcesContent":["import { delay } from '@xylabs/delay'\n\nexport interface ForgetTimeoutConfig {\n  cancel: () => void\n  delay: number\n}\n\nexport const ForgetPromise = {\n  get active() {\n    return this.activeForgets > 0\n  },\n\n  activeForgets: 0,\n\n  async awaitInactive(interval = 100, timeout?: number) {\n    let timeoutRemaining = timeout\n    while (this.active) {\n      await delay(interval)\n      if (timeoutRemaining !== undefined) {\n        timeoutRemaining -= interval\n        if (timeoutRemaining <= 0) {\n          return this.activeForgets\n        }\n      }\n    }\n    return 0\n  },\n\n  /**\n   * Used to explicitly launch an async function (or Promise) with awaiting it\n   * @param promise The promise to forget\n   * @param config Configuration of forget settings\n   */\n  forget<T>(promise: Promise<T>, config?: ForgetTimeoutConfig) {\n    let completed = false\n    this.activeForgets++\n\n    const promiseWrapper = async () => {\n      await promise\n        .then(() => {\n          this.activeForgets--\n          completed = true\n        })\n        .catch(() => {\n          this.activeForgets--\n          completed = true\n        })\n    }\n\n    const promises = [promiseWrapper()]\n\n    // if there is a timeout, add it to the race\n    if (config) {\n      const timeoutFunc = async () => {\n        await delay(config.delay)\n        if (!completed) {\n          console.log(`forget promise timeout out after ${config.delay}ms [Cancelling]`)\n          config.cancel?.()\n        }\n      }\n      promises.push(timeoutFunc())\n    }\n\n    const all = Promise.race(promises)\n\n    all\n      .then(() => {\n        return\n      })\n      .catch(() => {\n        return\n      })\n  },\n}\n\n// used to explicitly launch an async function (or Promise) with awaiting it\nexport const forget = (promise: Promise<unknown>, timeout?: ForgetTimeoutConfig) => {\n  ForgetPromise.forget(promise, timeout)\n}\n"],"mappings":";AAAA,SAAS,aAAa;AAOf,IAAM,gBAAgB;AAAA,EAC3B,IAAI,SAAS;AACX,WAAO,KAAK,gBAAgB;AAAA,EAC9B;AAAA,EAEA,eAAe;AAAA,EAEf,MAAM,cAAc,WAAW,KAAK,SAAkB;AACpD,QAAI,mBAAmB;AACvB,WAAO,KAAK,QAAQ;AAClB,YAAM,MAAM,QAAQ;AACpB,UAAI,qBAAqB,QAAW;AAClC,4BAAoB;AACpB,YAAI,oBAAoB,GAAG;AACzB,iBAAO,KAAK;AAAA,QACd;AAAA,MACF;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAU,SAAqB,QAA8B;AAC3D,QAAI,YAAY;AAChB,SAAK;AAEL,UAAM,iBAAiB,YAAY;AACjC,YAAM,QACH,KAAK,MAAM;AACV,aAAK;AACL,oBAAY;AAAA,MACd,CAAC,EACA,MAAM,MAAM;AACX,aAAK;AACL,oBAAY;AAAA,MACd,CAAC;AAAA,IACL;AAEA,UAAM,WAAW,CAAC,eAAe,CAAC;AAGlC,QAAI,QAAQ;AACV,YAAM,cAAc,YAAY;AAC9B,cAAM,MAAM,OAAO,KAAK;AACxB,YAAI,CAAC,WAAW;AACd,kBAAQ,IAAI,oCAAoC,OAAO,KAAK,iBAAiB;AAC7E,iBAAO,SAAS;AAAA,QAClB;AAAA,MACF;AACA,eAAS,KAAK,YAAY,CAAC;AAAA,IAC7B;AAEA,UAAM,MAAM,QAAQ,KAAK,QAAQ;AAEjC,QACG,KAAK,MAAM;AACV;AAAA,IACF,CAAC,EACA,MAAM,MAAM;AACX;AAAA,IACF,CAAC;AAAA,EACL;AACF;AAGO,IAAM,SAAS,CAAC,SAA2B,YAAkC;AAClF,gBAAc,OAAO,SAAS,OAAO;AACvC;","names":[]}
+{"version":3,"sources":["../../src/forget.ts"],"sourcesContent":["import { delay } from '@xylabs/delay'\n\nexport interface ForgetTimeoutConfig {\n  cancel: () => void\n  delay: number\n}\n\nexport const ForgetPromise = {\n  get active() {\n    return this.activeForgets > 0\n  },\n\n  activeForgets: 0,\n\n  async awaitInactive(interval = 100, timeout?: number) {\n    let timeoutRemaining = timeout\n    while (this.active) {\n      await delay(interval)\n      if (timeoutRemaining !== undefined) {\n        timeoutRemaining -= interval\n        if (timeoutRemaining <= 0) {\n          return this.activeForgets\n        }\n      }\n    }\n    return 0\n  },\n\n  /**\n   * Used to explicitly launch an async function (or Promise) with awaiting it\n   * @param promise The promise to forget\n   * @param config Configuration of forget settings\n   */\n  forget<T>(promise: Promise<T>, onComplete?: (result: [T | undefined, Error | undefined]) => void, config?: ForgetTimeoutConfig) {\n    let completed = false\n    this.activeForgets++\n\n    const promiseWrapper = async () => {\n      await promise\n        .then((result: T) => {\n          this.activeForgets--\n          completed = true\n          onComplete?.([result, undefined])\n        })\n        .catch((error) => {\n          this.activeForgets--\n          completed = true\n          onComplete?.([undefined, error])\n        })\n    }\n\n    const promises = [promiseWrapper()]\n\n    // if there is a timeout, add it to the race\n    if (config) {\n      const timeoutFunc = async () => {\n        await delay(config.delay)\n        if (!completed) {\n          console.log(`forget promise timeout out after ${config.delay}ms [Cancelling]`)\n          config.cancel?.()\n        }\n      }\n      promises.push(timeoutFunc())\n    }\n\n    const all = Promise.race(promises)\n\n    all\n      .then(() => {\n        return\n      })\n      .catch(() => {\n        return\n      })\n  },\n}\n\n// used to explicitly launch an async function (or Promise) with awaiting it\nexport const forget = <T>(promise: Promise<T>, onComplete?: (result: [T | undefined, Error | undefined]) => void, timeout?: ForgetTimeoutConfig) => {\n  ForgetPromise.forget<T>(promise, onComplete, timeout)\n}\n"],"mappings":";AAAA,SAAS,aAAa;AAOf,IAAM,gBAAgB;AAAA,EAC3B,IAAI,SAAS;AACX,WAAO,KAAK,gBAAgB;AAAA,EAC9B;AAAA,EAEA,eAAe;AAAA,EAEf,MAAM,cAAc,WAAW,KAAK,SAAkB;AACpD,QAAI,mBAAmB;AACvB,WAAO,KAAK,QAAQ;AAClB,YAAM,MAAM,QAAQ;AACpB,UAAI,qBAAqB,QAAW;AAClC,4BAAoB;AACpB,YAAI,oBAAoB,GAAG;AACzB,iBAAO,KAAK;AAAA,QACd;AAAA,MACF;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAU,SAAqB,YAAmE,QAA8B;AAC9H,QAAI,YAAY;AAChB,SAAK;AAEL,UAAM,iBAAiB,YAAY;AACjC,YAAM,QACH,KAAK,CAAC,WAAc;AACnB,aAAK;AACL,oBAAY;AACZ,qBAAa,CAAC,QAAQ,MAAS,CAAC;AAAA,MAClC,CAAC,EACA,MAAM,CAAC,UAAU;AAChB,aAAK;AACL,oBAAY;AACZ,qBAAa,CAAC,QAAW,KAAK,CAAC;AAAA,MACjC,CAAC;AAAA,IACL;AAEA,UAAM,WAAW,CAAC,eAAe,CAAC;AAGlC,QAAI,QAAQ;AACV,YAAM,cAAc,YAAY;AAC9B,cAAM,MAAM,OAAO,KAAK;AACxB,YAAI,CAAC,WAAW;AACd,kBAAQ,IAAI,oCAAoC,OAAO,KAAK,iBAAiB;AAC7E,iBAAO,SAAS;AAAA,QAClB;AAAA,MACF;AACA,eAAS,KAAK,YAAY,CAAC;AAAA,IAC7B;AAEA,UAAM,MAAM,QAAQ,KAAK,QAAQ;AAEjC,QACG,KAAK,MAAM;AACV;AAAA,IACF,CAAC,EACA,MAAM,MAAM;AACX;AAAA,IACF,CAAC;AAAA,EACL;AACF;AAGO,IAAM,SAAS,CAAI,SAAqB,YAAmE,YAAkC;AAClJ,gBAAc,OAAU,SAAS,YAAY,OAAO;AACtD;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/forget",
-  "version": "4.0.3",
+  "version": "4.0.5",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "forget",
@@ -36,11 +36,11 @@
   "module": "./dist/neutral/index.mjs",
   "types": "./dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/delay": "^4.0.3"
+    "@xylabs/delay": "^4.0.5"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^4.0.0",
-    "@xylabs/tsconfig": "^4.0.0",
+    "@xylabs/ts-scripts-yarn3": "^4.0.7",
+    "@xylabs/tsconfig": "^4.0.7",
     "typescript": "^5.5.4"
   },
   "engines": {

package/src/forget.ts

@@ -31,19 +31,21 @@ export const ForgetPromise = {
    * @param promise The promise to forget
    * @param config Configuration of forget settings
    */
-  forget<T>(promise: Promise<T>, config?: ForgetTimeoutConfig) {
+  forget<T>(promise: Promise<T>, onComplete?: (result: [T | undefined, Error | undefined]) => void, config?: ForgetTimeoutConfig) {
     let completed = false
     this.activeForgets++
 
     const promiseWrapper = async () => {
       await promise
-        .then(() => {
+        .then((result: T) => {
           this.activeForgets--
           completed = true
+          onComplete?.([result, undefined])
         })
-        .catch(() => {
+        .catch((error) => {
           this.activeForgets--
           completed = true
+          onComplete?.([undefined, error])
         })
     }
 
@@ -74,6 +76,6 @@ export const ForgetPromise = {
 }
 
 // used to explicitly launch an async function (or Promise) with awaiting it
-export const forget = (promise: Promise<unknown>, timeout?: ForgetTimeoutConfig) => {
-  ForgetPromise.forget(promise, timeout)
+export const forget = <T>(promise: Promise<T>, onComplete?: (result: [T | undefined, Error | undefined]) => void, timeout?: ForgetTimeoutConfig) => {
+  ForgetPromise.forget<T>(promise, onComplete, timeout)
 }