@xylabs/forget 4.13.4 → 4.13.6

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,35 +1,33 @@
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 { }
1
+ import { Promisable, PromiseEx } from '@xylabs/promise';
2
+ import { Logger } from '@xylabs/logger';
3
+
4
+ interface ForgetConfig<T = any> {
5
+ name?: string;
6
+ onCancel?: () => void;
7
+ onComplete?: (result: [T | undefined, Error | undefined]) => void;
8
+ onException?: (error: Error) => void;
9
+ timeout?: number;
10
+ }
11
+ declare const defaultForgetConfig: ForgetConfig<unknown>;
12
+
13
+ declare const forget: <T>(promise: Promisable<T>, config?: ForgetConfig<T>) => void;
14
+
15
+ type PromisableFunction<T> = () => Promisable<T>;
16
+ declare class ForgetPromise {
17
+ static activeForgets: number;
18
+ static exceptedForgets: number;
19
+ static logger: Logger;
20
+ static get active(): boolean;
21
+ static awaitInactive(interval?: number, timeout?: number): Promise<number>;
22
+ static exceptionHandler(error: Error, { name }: ForgetConfig, externalStackTrace?: string): void;
23
+ /**
24
+ * Used to explicitly launch an async function (or Promise) with awaiting it
25
+ * @param promise The promise to forget
26
+ * @param config Configuration of forget settings
27
+ */
28
+ static forget<T>(promise: Promise<T> | PromiseEx<T> | PromisableFunction<T> | T, config?: ForgetConfig<T>): void;
29
+ static timeoutHandler(time: number, { name }: ForgetConfig, externalStackTrace?: string): void;
30
+ }
31
+
32
+ export { ForgetPromise, defaultForgetConfig, forget };
33
+ export type { ForgetConfig };
@@ -1,46 +1,44 @@
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 { }
1
+ import { Promisable, PromiseEx } from '@xylabs/promise';
2
+ import { Logger } from '@xylabs/logger';
3
+
4
+ interface ForgetConfig<T = any> {
5
+ name?: string;
6
+ onCancel?: () => void;
7
+ onComplete?: (result: [T | undefined, Error | undefined]) => void;
8
+ onException?: (error: Error) => void;
9
+ timeout?: number;
10
+ }
11
+
12
+ interface ForgetNodeConfig<T = any> extends ForgetConfig<T> {
13
+ terminateOnException?: boolean;
14
+ terminateOnTimeout?: boolean;
15
+ }
16
+ declare const defaultForgetNodeConfig: ForgetNodeConfig<unknown>;
17
+
18
+ declare const forgetNode: <T>(promise: Promisable<T>, config?: ForgetNodeConfig<T>) => void;
19
+
20
+ type PromisableFunction<T> = () => Promisable<T>;
21
+ declare class ForgetPromise {
22
+ static activeForgets: number;
23
+ static exceptedForgets: number;
24
+ static logger: Logger;
25
+ static get active(): boolean;
26
+ static awaitInactive(interval?: number, timeout?: number): Promise<number>;
27
+ static exceptionHandler(error: Error, { name }: ForgetConfig, externalStackTrace?: string): void;
28
+ /**
29
+ * Used to explicitly launch an async function (or Promise) with awaiting it
30
+ * @param promise The promise to forget
31
+ * @param config Configuration of forget settings
32
+ */
33
+ static forget<T>(promise: Promise<T> | PromiseEx<T> | PromisableFunction<T> | T, config?: ForgetConfig<T>): void;
34
+ static timeoutHandler(time: number, { name }: ForgetConfig, externalStackTrace?: string): void;
35
+ }
36
+
37
+ declare class ForgetPromiseNode extends ForgetPromise {
38
+ static exceptionHandler(error: Error, config: ForgetNodeConfig, externalStackTrace?: string): void;
39
+ static forget<T>(promise: Promisable<T>, config?: ForgetNodeConfig<T>): void;
40
+ static timeoutHandler(time: number, config: ForgetNodeConfig, externalStackTrace?: string): void;
41
+ }
42
+
43
+ export { ForgetPromiseNode as ForgetPromise, defaultForgetNodeConfig, forgetNode as forget };
44
+ export type { ForgetNodeConfig };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xylabs/forget",
3
- "version": "4.13.4",
3
+ "version": "4.13.6",
4
4
  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
5
5
  "keywords": [
6
6
  "forget",
@@ -40,14 +40,14 @@
40
40
  "module": "./dist/node/index.mjs",
41
41
  "types": "./dist/node/node/index.d.ts",
42
42
  "dependencies": {
43
- "@xylabs/delay": "^4.13.4",
44
- "@xylabs/logger": "^4.13.4",
45
- "@xylabs/promise": "^4.13.4",
46
- "@xylabs/typeof": "^4.13.4"
43
+ "@xylabs/delay": "^4.13.6",
44
+ "@xylabs/logger": "^4.13.6",
45
+ "@xylabs/promise": "^4.13.6",
46
+ "@xylabs/typeof": "^4.13.6"
47
47
  },
48
48
  "devDependencies": {
49
- "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.7",
50
- "@xylabs/tsconfig-dom": "^7.0.0-rc.7",
49
+ "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.8",
50
+ "@xylabs/tsconfig-dom": "^7.0.0-rc.8",
51
51
  "typescript": "^5.8.3",
52
52
  "vitest": "^3.2.4"
53
53
  },