@xylabs/forget 4.13.15 → 4.13.17

package/README.md

@@ -1,62 +1,54 @@
-[![logo][]](https://xylabs.com)
-
 # @xylabs/forget
 
+[![logo][]](https://xylabs.com)
+
+[![main-build][]][main-build-link]
 [![npm-badge][]][npm-link]
 [![npm-downloads-badge][]][npm-link]
 [![jsdelivr-badge][]][jsdelivr-link]
 [![npm-license-badge][]](LICENSE)
+[![codacy-badge][]][codacy-link]
+[![codeclimate-badge][]][codeclimate-link]
+[![snyk-badge][]][snyk-link]
+[![socket-badge][]][socket-link]
 
-> XY Labs generalized Javascript library 
-
-## Table of Contents
-
--   [Description](#description)
--   [Install](#install)
--   [Maintainers](#maintainers)
--   [License](#license)
--   [Credits](#credits)
-
-## Description
+Version: 4.13.15
 
-Common Javascript code that is used throughout XYO projects that use React.
+Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
-## Install
-
-Using npm:
-
-```sh
-npm i --save @xylabs/forget
-```
+## Documentation
 
-Using yarn:
+Coming Soon!
 
-```sh
-yarn add @xylabs/forget
-```
-
-## Documentation
-[Developer Reference](https://xylabs.github.io/sdk-js)
+Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 
 ## Maintainers
 
 -   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
--   [Joel Carter](https://github.com/JoelBCarter)
 -   [Matt Jones](https://github.com/jonesmac)
+-   [Joel Carter](https://github.com/JoelBCarter)
 -   [Jordan Trouw](https://github.com/jordantrouw)
 
 ## License
 
-See the [LICENSE](LICENSE) file for license details
+> See the [LICENSE](LICENSE) file for license details
 
 ## Credits
 
-[Made with 🔥and ❄️ by XY Labs](https://xylabs.com)
+[Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
 
 [logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
 
+[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
+[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
 [npm-badge]: https://img.shields.io/npm/v/@xylabs/forget.svg
 [npm-link]: https://www.npmjs.com/package/@xylabs/forget
+[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
+[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
+[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
+[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
+[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
+[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
 
 [npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/forget
 [npm-license-badge]: https://img.shields.io/npm/l/@xylabs/forget

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

@@ -1,33 +1,4 @@
-import { Promisable, PromiseEx } from '@xylabs/promise';
-import { Logger } from '@xylabs/logger';
-
-interface ForgetConfig<T = any> {
-    name?: string;
-    onCancel?: () => void;
-    onComplete?: (result: [T | undefined, Error | undefined]) => void;
-    onException?: (error: Error) => void;
-    timeout?: number;
-}
-declare const defaultForgetConfig: ForgetConfig<unknown>;
-
-declare const forget: <T>(promise: Promisable<T>, config?: ForgetConfig<T>) => void;
-
-type PromisableFunction<T> = () => Promisable<T>;
-declare class ForgetPromise {
-    static activeForgets: number;
-    static exceptedForgets: number;
-    static logger: Logger;
-    static get active(): boolean;
-    static awaitInactive(interval?: number, timeout?: number): Promise<number>;
-    static exceptionHandler(error: Error, { name }: ForgetConfig, externalStackTrace?: string): void;
-    /**
-     * Used to explicitly launch an async function (or Promise) with awaiting it
-     * @param promise The promise to forget
-     * @param config Configuration of forget settings
-     */
-    static forget<T>(promise: Promise<T> | PromiseEx<T> | PromisableFunction<T> | T, config?: ForgetConfig<T>): void;
-    static timeoutHandler(time: number, { name }: ForgetConfig, externalStackTrace?: string): void;
-}
-
-export { ForgetPromise, defaultForgetConfig, forget };
-export type { ForgetConfig };
+export * from '../forget.ts';
+export * from '../ForgetConfig.ts';
+export * from '../ForgetPromise.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/neutral/spec/forget.node.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=forget.node.spec.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"forget.node.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/forget.node.spec.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=forget.spec.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"forget.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/forget.spec.ts"],"names":[],"mappings":""}

package/dist/node/ForgetNodeConfig.d.ts

@@ -0,0 +1,7 @@
+import { type ForgetConfig } from './ForgetConfig.ts';
+export interface ForgetNodeConfig<T = any> extends ForgetConfig<T> {
+    terminateOnException?: boolean;
+    terminateOnTimeout?: boolean;
+}
+export declare const defaultForgetNodeConfig: ForgetNodeConfig<unknown>;
+//# sourceMappingURL=ForgetNodeConfig.d.ts.map

package/dist/node/ForgetNodeConfig.d.ts.map

@@ -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"}

package/dist/node/ForgetPromiseNode.d.ts

@@ -0,0 +1,9 @@
+import type { Promisable } from '@xylabs/promise';
+import { type ForgetNodeConfig } from './ForgetNodeConfig.ts';
+import { ForgetPromise } from './ForgetPromise.ts';
+export declare class ForgetPromiseNode extends ForgetPromise {
+    static exceptionHandler(error: Error, config: ForgetNodeConfig, externalStackTrace?: string): void;
+    static forget<T>(promise: Promisable<T>, config?: ForgetNodeConfig<T>): void;
+    static timeoutHandler(time: number, config: ForgetNodeConfig, externalStackTrace?: string): void;
+}
+//# sourceMappingURL=ForgetPromiseNode.d.ts.map

package/dist/node/ForgetPromiseNode.d.ts.map

@@ -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"}

package/dist/node/forget.d.ts

@@ -0,0 +1,4 @@
+import { type Promisable } from '@xylabs/promise';
+import type { ForgetConfig } from './ForgetConfig.ts';
+export declare const forget: <T>(promise: Promisable<T>, config?: ForgetConfig<T>) => void;
+//# sourceMappingURL=forget.d.ts.map

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

@@ -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"}

package/dist/node/forgetNode.d.ts

@@ -0,0 +1,4 @@
+import { type Promisable } from '@xylabs/promise';
+import type { ForgetNodeConfig } from './ForgetNodeConfig.ts';
+export declare const forgetNode: <T>(promise: Promisable<T>, config?: ForgetNodeConfig<T>) => void;
+//# sourceMappingURL=forgetNode.d.ts.map

package/dist/node/forgetNode.d.ts.map

@@ -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"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/neutral/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,oBAAoB,CAAA;AAClC,cAAc,qBAAqB,CAAA"}

package/dist/node/node/index.d.ts

@@ -1,44 +1,4 @@
-import { Promisable, PromiseEx } from '@xylabs/promise';
-import { Logger } from '@xylabs/logger';
-
-interface ForgetConfig<T = any> {
-    name?: string;
-    onCancel?: () => void;
-    onComplete?: (result: [T | undefined, Error | undefined]) => void;
-    onException?: (error: Error) => void;
-    timeout?: number;
-}
-
-interface ForgetNodeConfig<T = any> extends ForgetConfig<T> {
-    terminateOnException?: boolean;
-    terminateOnTimeout?: boolean;
-}
-declare const defaultForgetNodeConfig: ForgetNodeConfig<unknown>;
-
-declare const forgetNode: <T>(promise: Promisable<T>, config?: ForgetNodeConfig<T>) => void;
-
-type PromisableFunction<T> = () => Promisable<T>;
-declare class ForgetPromise {
-    static activeForgets: number;
-    static exceptedForgets: number;
-    static logger: Logger;
-    static get active(): boolean;
-    static awaitInactive(interval?: number, timeout?: number): Promise<number>;
-    static exceptionHandler(error: Error, { name }: ForgetConfig, externalStackTrace?: string): void;
-    /**
-     * Used to explicitly launch an async function (or Promise) with awaiting it
-     * @param promise The promise to forget
-     * @param config Configuration of forget settings
-     */
-    static forget<T>(promise: Promise<T> | PromiseEx<T> | PromisableFunction<T> | T, config?: ForgetConfig<T>): void;
-    static timeoutHandler(time: number, { name }: ForgetConfig, externalStackTrace?: string): void;
-}
-
-declare class ForgetPromiseNode extends ForgetPromise {
-    static exceptionHandler(error: Error, config: ForgetNodeConfig, externalStackTrace?: string): void;
-    static forget<T>(promise: Promisable<T>, config?: ForgetNodeConfig<T>): void;
-    static timeoutHandler(time: number, config: ForgetNodeConfig, externalStackTrace?: string): void;
-}
-
-export { ForgetPromiseNode as ForgetPromise, defaultForgetNodeConfig, forgetNode as forget };
-export type { ForgetNodeConfig };
+export { forgetNode as forget } from '../forgetNode.ts';
+export * from '../ForgetNodeConfig.ts';
+export { ForgetPromiseNode as ForgetPromise } from '../ForgetPromiseNode.ts';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/node/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,IAAI,MAAM,EAAE,MAAM,kBAAkB,CAAA;AACvD,cAAc,wBAAwB,CAAA;AACtC,OAAO,EAAE,iBAAiB,IAAI,aAAa,EAAE,MAAM,yBAAyB,CAAA"}

package/dist/node/spec/forget.node.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=forget.node.spec.d.ts.map

package/dist/node/spec/forget.node.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"forget.node.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/forget.node.spec.ts"],"names":[],"mappings":""}

package/dist/node/spec/forget.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=forget.spec.d.ts.map

package/dist/node/spec/forget.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"forget.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/forget.spec.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/forget",
-  "version": "4.13.15",
+  "version": "4.13.17",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "forget",
@@ -40,14 +40,14 @@
   "module": "./dist/node/index.mjs",
   "types": "./dist/node/node/index.d.ts",
   "dependencies": {
-    "@xylabs/delay": "^4.13.15",
-    "@xylabs/logger": "^4.13.15",
-    "@xylabs/promise": "^4.13.15",
-    "@xylabs/typeof": "^4.13.15"
+    "@xylabs/delay": "^4.13.17",
+    "@xylabs/logger": "^4.13.17",
+    "@xylabs/promise": "^4.13.17",
+    "@xylabs/typeof": "^4.13.17"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
-    "@xylabs/tsconfig-dom": "^7.0.0-rc.20",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
+    "@xylabs/tsconfig-dom": "^7.0.0-rc.27",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },