@xylabs/forget 4.12.44 → 4.13.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,21 +1,35 @@
1
- import type { Logger } from '@xylabs/logger';
2
- import type { Promisable, PromiseEx } from '@xylabs/promise';
3
- import { type ForgetConfig } from './ForgetConfig.ts';
4
- type PromisableFunction<T> = () => Promisable<T>;
5
- export declare class ForgetPromise {
6
- static activeForgets: number;
7
- static exceptedForgets: number;
8
- static logger: Logger;
9
- static get active(): boolean;
10
- static awaitInactive(interval?: number, timeout?: number): Promise<number>;
11
- static exceptionHandler(error: Error, { name }: ForgetConfig, externalStackTrace?: string): void;
12
- /**
13
- * Used to explicitly launch an async function (or Promise) with awaiting it
14
- * @param promise The promise to forget
15
- * @param config Configuration of forget settings
16
- */
17
- static forget<T>(promise: Promise<T> | PromiseEx<T> | PromisableFunction<T> | T, config?: ForgetConfig<T>): void;
18
- static timeoutHandler(time: number, { name }: ForgetConfig, externalStackTrace?: string): void;
19
- }
20
- export {};
21
- //# sourceMappingURL=ForgetPromise.d.ts.map
1
+ import type { Logger } from '@xylabs/logger';
2
+ import { Promisable } from '@xylabs/promise';
3
+ import type { PromiseEx } from '@xylabs/promise';
4
+
5
+ export declare const defaultForgetConfig: ForgetConfig<unknown>;
6
+
7
+ export declare const forget: <T>(promise: Promisable<T>, config?: ForgetConfig<T>) => void;
8
+
9
+ export declare interface ForgetConfig<T = any> {
10
+ name?: string;
11
+ onCancel?: () => void;
12
+ onComplete?: (result: [T | undefined, Error | undefined]) => void;
13
+ onException?: (error: Error) => void;
14
+ timeout?: number;
15
+ }
16
+
17
+ export declare class ForgetPromise {
18
+ static activeForgets: number;
19
+ static exceptedForgets: number;
20
+ static logger: Logger;
21
+ static get active(): boolean;
22
+ static awaitInactive(interval?: number, timeout?: number): Promise<number>;
23
+ static exceptionHandler(error: Error, { name }: ForgetConfig, externalStackTrace?: string): void;
24
+ /**
25
+ * Used to explicitly launch an async function (or Promise) with awaiting it
26
+ * @param promise The promise to forget
27
+ * @param config Configuration of forget settings
28
+ */
29
+ static forget<T>(promise: Promise<T> | PromiseEx<T> | PromisableFunction<T> | T, config?: ForgetConfig<T>): void;
30
+ static timeoutHandler(time: number, { name }: ForgetConfig, externalStackTrace?: string): void;
31
+ }
32
+
33
+ declare type PromisableFunction<T> = () => Promisable<T>;
34
+
35
+ export { }
@@ -137,4 +137,4 @@ export {
137
137
  defaultForgetNodeConfig,
138
138
  forgetNode as forget
139
139
  };
140
- //# sourceMappingURL=index-node.mjs.map
140
+ //# sourceMappingURL=index.mjs.map
@@ -0,0 +1,46 @@
1
+ import type { Logger } from '@xylabs/logger';
2
+ import { Promisable } from '@xylabs/promise';
3
+ import type { PromiseEx } from '@xylabs/promise';
4
+
5
+ export declare const defaultForgetNodeConfig: ForgetNodeConfig<unknown>;
6
+
7
+ export declare const forget: <T>(promise: Promisable<T>, config?: ForgetNodeConfig<T>) => void;
8
+
9
+ declare interface ForgetConfig<T = any> {
10
+ name?: string;
11
+ onCancel?: () => void;
12
+ onComplete?: (result: [T | undefined, Error | undefined]) => void;
13
+ onException?: (error: Error) => void;
14
+ timeout?: number;
15
+ }
16
+
17
+ export declare interface ForgetNodeConfig<T = any> extends ForgetConfig<T> {
18
+ terminateOnException?: boolean;
19
+ terminateOnTimeout?: boolean;
20
+ }
21
+
22
+ export declare class ForgetPromise extends ForgetPromise_2 {
23
+ static exceptionHandler(error: Error, config: ForgetNodeConfig, externalStackTrace?: string): void;
24
+ static forget<T>(promise: Promisable<T>, config?: ForgetNodeConfig<T>): void;
25
+ static timeoutHandler(time: number, config: ForgetNodeConfig, externalStackTrace?: string): void;
26
+ }
27
+
28
+ declare class ForgetPromise_2 {
29
+ static activeForgets: number;
30
+ static exceptedForgets: number;
31
+ static logger: Logger;
32
+ static get active(): boolean;
33
+ static awaitInactive(interval?: number, timeout?: number): Promise<number>;
34
+ static exceptionHandler(error: Error, { name }: ForgetConfig, externalStackTrace?: string): void;
35
+ /**
36
+ * Used to explicitly launch an async function (or Promise) with awaiting it
37
+ * @param promise The promise to forget
38
+ * @param config Configuration of forget settings
39
+ */
40
+ static forget<T>(promise: Promise<T> | PromiseEx<T> | PromisableFunction<T> | T, config?: ForgetConfig<T>): void;
41
+ static timeoutHandler(time: number, { name }: ForgetConfig, externalStackTrace?: string): void;
42
+ }
43
+
44
+ declare type PromisableFunction<T> = () => Promisable<T>;
45
+
46
+ export { }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xylabs/forget",
3
- "version": "4.12.44",
3
+ "version": "4.13.1",
4
4
  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
5
5
  "keywords": [
6
6
  "forget",
@@ -29,25 +29,25 @@
29
29
  "exports": {
30
30
  ".": {
31
31
  "node": {
32
- "types": "./dist/types/index-node.d.ts",
33
- "default": "./dist/node/index-node.mjs"
32
+ "types": "./dist/node/node/index.d.ts",
33
+ "default": "./dist/node/index.mjs"
34
34
  },
35
- "types": "./dist/types/index.d.ts",
36
- "default": "./dist/node/index-node.mjs"
35
+ "types": "./dist/node/node/index.d.ts",
36
+ "default": "./dist/node/index.mjs"
37
37
  },
38
38
  "./package.json": "./package.json"
39
39
  },
40
- "module": "./dist/node/index-node.mjs",
41
- "types": "./dist/types/index.d.ts",
40
+ "module": "./dist/node/index.mjs",
41
+ "types": "./dist/node/node/index.d.ts",
42
42
  "dependencies": {
43
- "@xylabs/delay": "^4.12.44",
44
- "@xylabs/logger": "^4.12.44",
45
- "@xylabs/promise": "^4.12.44",
46
- "@xylabs/typeof": "^4.12.44"
43
+ "@xylabs/delay": "^4.13.1",
44
+ "@xylabs/logger": "^4.13.1",
45
+ "@xylabs/promise": "^4.13.1",
46
+ "@xylabs/typeof": "^4.13.1"
47
47
  },
48
48
  "devDependencies": {
49
- "@xylabs/ts-scripts-yarn3": "^6.5.12",
50
- "@xylabs/tsconfig-dom": "^6.5.12",
49
+ "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.7",
50
+ "@xylabs/tsconfig-dom": "^7.0.0-rc.7",
51
51
  "typescript": "^5.8.3",
52
52
  "vitest": "^3.2.4"
53
53
  },
@@ -0,0 +1,3 @@
1
+ export * from '../forget.ts'
2
+ export * from '../ForgetConfig.ts'
3
+ export * from '../ForgetPromise.ts'
@@ -0,0 +1,3 @@
1
+ export { forgetNode as forget } from '../forgetNode.ts'
2
+ export * from '../ForgetNodeConfig.ts'
3
+ export { ForgetPromiseNode as ForgetPromise } from '../ForgetPromiseNode.ts'
package/xy.config.ts CHANGED
@@ -2,8 +2,8 @@ import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
2
2
  const config: XyTsupConfig = {
3
3
  compile: {
4
4
  browser: {},
5
- neutral: { src: { entry: ['src/index.ts'] } },
6
- node: { src: { entry: ['src/index-node.ts'] } },
5
+ neutral: { 'src/neutral': true },
6
+ node: { 'src/node': true },
7
7
  },
8
8
  }
9
9
 
@@ -1,9 +0,0 @@
1
- export interface ForgetConfig<T = any> {
2
- name?: string;
3
- onCancel?: () => void;
4
- onComplete?: (result: [T | undefined, Error | undefined]) => void;
5
- onException?: (error: Error) => void;
6
- timeout?: number;
7
- }
8
- export declare const defaultForgetConfig: ForgetConfig<unknown>;
9
- //# sourceMappingURL=ForgetConfig.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"ForgetConfig.d.ts","sourceRoot":"","sources":["../../src/ForgetConfig.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,YAAY,CAAC,CAAC,GAAG,GAAG;IACnC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAA;IACrB,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,SAAS,EAAE,KAAK,GAAG,SAAS,CAAC,KAAK,IAAI,CAAA;IACjE,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;IACpC,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,eAAO,MAAM,mBAAmB,EAAE,YAAY,CAAC,OAAO,CAAuB,CAAA"}
@@ -1,7 +0,0 @@
1
- import { type ForgetConfig } from './ForgetConfig.ts';
2
- export interface ForgetNodeConfig<T = any> extends ForgetConfig<T> {
3
- terminateOnException?: boolean;
4
- terminateOnTimeout?: boolean;
5
- }
6
- export declare const defaultForgetNodeConfig: ForgetNodeConfig<unknown>;
7
- //# sourceMappingURL=ForgetNodeConfig.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"ForgetNodeConfig.d.ts","sourceRoot":"","sources":["../../src/ForgetNodeConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,KAAK,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAG1E,MAAM,WAAW,gBAAgB,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,YAAY,CAAC,CAAC,CAAC;IAChE,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAC7B;AAED,eAAO,MAAM,uBAAuB,EAAE,gBAAgB,CAAC,OAAO,CAI7D,CAAA"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"ForgetPromise.d.ts","sourceRoot":"","sources":["../../src/ForgetPromise.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAI5D,OAAO,EAAuB,KAAK,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAE1E,KAAK,kBAAkB,CAAC,CAAC,IAAI,MAAM,UAAU,CAAC,CAAC,CAAC,CAAA;AAGhD,qBAAa,aAAa;IACxB,MAAM,CAAC,aAAa,SAAI;IACxB,MAAM,CAAC,eAAe,SAAI;IAC1B,MAAM,CAAC,MAAM,EAAE,MAAM,CAAU;IAE/B,MAAM,KAAK,MAAM,YAEhB;WAEY,aAAa,CAAC,QAAQ,SAAM,EAAE,OAAO,CAAC,EAAE,MAAM;IAc3D,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,YAAY,EAAE,kBAAkB,CAAC,EAAE,MAAM;IAOzF;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC;IA+DzG,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,IAAgB,EAAE,EAAE,YAAY,EAAE,kBAAkB,CAAC,EAAE,MAAM;CAMpG"}
@@ -1,9 +0,0 @@
1
- import type { Promisable } from '@xylabs/promise';
2
- import { type ForgetNodeConfig } from './ForgetNodeConfig.ts';
3
- import { ForgetPromise } from './ForgetPromise.ts';
4
- export declare class ForgetPromiseNode extends ForgetPromise {
5
- static exceptionHandler(error: Error, config: ForgetNodeConfig, externalStackTrace?: string): void;
6
- static forget<T>(promise: Promisable<T>, config?: ForgetNodeConfig<T>): void;
7
- static timeoutHandler(time: number, config: ForgetNodeConfig, externalStackTrace?: string): void;
8
- }
9
- //# sourceMappingURL=ForgetPromiseNode.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"ForgetPromiseNode.d.ts","sourceRoot":"","sources":["../../src/ForgetPromiseNode.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,OAAO,EAA2B,KAAK,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACtF,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAElD,qBAAa,iBAAkB,SAAQ,aAAa;WAClC,gBAAgB,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,kBAAkB,CAAC,EAAE,MAAM;WAUpF,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC;WAO9D,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,kBAAkB,CAAC,EAAE,MAAM;CAQnG"}
@@ -1,4 +0,0 @@
1
- import { type Promisable } from '@xylabs/promise';
2
- import type { ForgetConfig } from './ForgetConfig.ts';
3
- export declare const forget: <T>(promise: Promisable<T>, config?: ForgetConfig<T>) => void;
4
- //# sourceMappingURL=forget.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"forget.d.ts","sourceRoot":"","sources":["../../src/forget.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAIrD,eAAO,MAAM,MAAM,GAAI,CAAC,EAAE,SAAS,UAAU,CAAC,CAAC,CAAC,EAAE,SAAS,YAAY,CAAC,CAAC,CAAC,SAEzE,CAAA"}
@@ -1,4 +0,0 @@
1
- import { type Promisable } from '@xylabs/promise';
2
- import type { ForgetNodeConfig } from './ForgetNodeConfig.ts';
3
- export declare const forgetNode: <T>(promise: Promisable<T>, config?: ForgetNodeConfig<T>) => void;
4
- //# sourceMappingURL=forgetNode.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"forgetNode.d.ts","sourceRoot":"","sources":["../../src/forgetNode.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAI7D,eAAO,MAAM,UAAU,GAAI,CAAC,EAAE,SAAS,UAAU,CAAC,CAAC,CAAC,EAAE,SAAS,gBAAgB,CAAC,CAAC,CAAC,SAEjF,CAAA"}
@@ -1,4 +0,0 @@
1
- export { forgetNode as forget } from './forgetNode.ts';
2
- export * from './ForgetNodeConfig.ts';
3
- export { ForgetPromiseNode as ForgetPromise } from './ForgetPromiseNode.ts';
4
- //# sourceMappingURL=index-node.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index-node.d.ts","sourceRoot":"","sources":["../../src/index-node.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,IAAI,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACtD,cAAc,uBAAuB,CAAA;AACrC,OAAO,EAAE,iBAAiB,IAAI,aAAa,EAAE,MAAM,wBAAwB,CAAA"}
@@ -1,4 +0,0 @@
1
- export * from './forget.ts';
2
- export * from './ForgetConfig.ts';
3
- export * from './ForgetPromise.ts';
4
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,mBAAmB,CAAA;AACjC,cAAc,oBAAoB,CAAA"}
package/src/index-node.ts DELETED
@@ -1,3 +0,0 @@
1
- export { forgetNode as forget } from './forgetNode.ts'
2
- export * from './ForgetNodeConfig.ts'
3
- export { ForgetPromiseNode as ForgetPromise } from './ForgetPromiseNode.ts'
package/src/index.ts DELETED
@@ -1,3 +0,0 @@
1
- export * from './forget.ts'
2
- export * from './ForgetConfig.ts'
3
- export * from './ForgetPromise.ts'
File without changes