@nodesuite/defer - npm Package Compare versions

Comparing version 0.3.31 to 0.3.32

.rush/temp/operation/build_prod/state.json

 {
-  "nonCachedDurationMs": 2850.7947679999634
+  "nonCachedDurationMs": 2711.5208859999548
 }

.rush/temp/operation/lint/state.json

 {
-  "nonCachedDurationMs": 4549.472919999971
+  "nonCachedDurationMs": 4492.412511000002
 }

.rush/temp/operation/test/state.json

 {
-  "nonCachedDurationMs": 4143.740028000029
+  "nonCachedDurationMs": 4092.019092999981
 }

.rush/temp/package-deps_build_prod.json

 {
   "files": {
     "libraries/defer/.eslintrc.js": "da8f1d5b00175fe9df49681a80b909d918ac6736",
-    "libraries/defer/CHANGELOG.json": "485f12f634887fb48e8c06021375d9e16d168626",
-    "libraries/defer/CHANGELOG.md": "6a22813e4e57096f9d84295ba67bec144e260f1a",
+    "libraries/defer/CHANGELOG.json": "caae2936877cd29ad2ce934347d211a74952a275",
+    "libraries/defer/CHANGELOG.md": "0e3bffbf60dc8adce0cf1e335edd0e3e2f8e86b4",
     "libraries/defer/README.md": "84db0578b100eb3e4e7c0b16c62b9e0ef747115f",
     "libraries/defer/config/jest.config.json": "e7403ac0133ef474bfbdbe4b1d79a3fb248eac0b",
     "libraries/defer/config/rig.json": "54137d20557298060eb70cf9e72e9ce1c7b7e130",
-    "libraries/defer/package.json": "cdfc89bae8f8aa09017e5a4a9038c78fcf76477a",
+    "libraries/defer/package.json": "734d59a69b2a2ed412b04ab59cad2686c41be090",
     "libraries/defer/src/deferral.ts": "d6fe7a259ca78167ec669b3a1ed0471a31b1dd46",
@@ -11,0 +11,0 @@ "libraries/defer/src/index.ts": "fa766482f82be71040012716274e5f649d5828a8",

.rush/temp/package-deps_lint.json

 {
   "files": {
     "libraries/defer/.eslintrc.js": "da8f1d5b00175fe9df49681a80b909d918ac6736",
-    "libraries/defer/CHANGELOG.json": "485f12f634887fb48e8c06021375d9e16d168626",
-    "libraries/defer/CHANGELOG.md": "6a22813e4e57096f9d84295ba67bec144e260f1a",
+    "libraries/defer/CHANGELOG.json": "caae2936877cd29ad2ce934347d211a74952a275",
+    "libraries/defer/CHANGELOG.md": "0e3bffbf60dc8adce0cf1e335edd0e3e2f8e86b4",
     "libraries/defer/README.md": "84db0578b100eb3e4e7c0b16c62b9e0ef747115f",
     "libraries/defer/config/jest.config.json": "e7403ac0133ef474bfbdbe4b1d79a3fb248eac0b",
     "libraries/defer/config/rig.json": "54137d20557298060eb70cf9e72e9ce1c7b7e130",
-    "libraries/defer/package.json": "cdfc89bae8f8aa09017e5a4a9038c78fcf76477a",
+    "libraries/defer/package.json": "734d59a69b2a2ed412b04ab59cad2686c41be090",
     "libraries/defer/src/deferral.ts": "d6fe7a259ca78167ec669b3a1ed0471a31b1dd46",
@@ -11,0 +11,0 @@ "libraries/defer/src/index.ts": "fa766482f82be71040012716274e5f649d5828a8",

.rush/temp/package-deps_test.json

 {
   "files": {
     "libraries/defer/.eslintrc.js": "da8f1d5b00175fe9df49681a80b909d918ac6736",
-    "libraries/defer/CHANGELOG.json": "485f12f634887fb48e8c06021375d9e16d168626",
-    "libraries/defer/CHANGELOG.md": "6a22813e4e57096f9d84295ba67bec144e260f1a",
+    "libraries/defer/CHANGELOG.json": "caae2936877cd29ad2ce934347d211a74952a275",
+    "libraries/defer/CHANGELOG.md": "0e3bffbf60dc8adce0cf1e335edd0e3e2f8e86b4",
     "libraries/defer/README.md": "84db0578b100eb3e4e7c0b16c62b9e0ef747115f",
     "libraries/defer/config/jest.config.json": "e7403ac0133ef474bfbdbe4b1d79a3fb248eac0b",
     "libraries/defer/config/rig.json": "54137d20557298060eb70cf9e72e9ce1c7b7e130",
-    "libraries/defer/package.json": "cdfc89bae8f8aa09017e5a4a9038c78fcf76477a",
+    "libraries/defer/package.json": "734d59a69b2a2ed412b04ab59cad2686c41be090",
     "libraries/defer/src/deferral.ts": "d6fe7a259ca78167ec669b3a1ed0471a31b1dd46",
@@ -11,0 +11,0 @@ "libraries/defer/src/index.ts": "fa766482f82be71040012716274e5f649d5828a8",

CHANGELOG.json

@@ -5,2 +5,8 @@ {
     {
+      "version": "0.3.32",
+      "tag": "@nodesuite/defer_v0.3.32",
+      "date": "Wed, 15 Feb 2023 00:52:39 GMT",
+      "comments": {}
+    },
+    {
       "version": "0.3.31",
@@ -7,0 +13,0 @@ "tag": "@nodesuite/defer_v0.3.31",

CHANGELOG.md

 # Change Log - @nodesuite/defer
 
-This log was last generated on Mon, 13 Feb 2023 02:09:05 GMT and should not be manually modified.
+This log was last generated on Wed, 15 Feb 2023 00:52:39 GMT and should not be manually modified.
 
+## 0.3.32
+Wed, 15 Feb 2023 00:52:39 GMT
+
+_Version update only_
+
 ## 0.3.31
@@ -6,0 +11,0 @@ Mon, 13 Feb 2023 02:09:05 GMT

dist/index.d.ts

@@ -1,4 +0,103 @@
-export * from "./deferral";
-export * from "./provider";
-export * from "./types";
-//# sourceMappingURL=index.d.ts.map
+/**
+ * Resolve method signature.
+ *
+ * @public
+ */
+type Resolver<R = void> = (value: R) => void;
+/**
+ * Reject method signature.
+ *
+ * @public
+ */
+type Rejection = (reason?: string | Error | unknown) => void;
+/**
+ * Abstract deferred promise.
+ *
+ * @public
+ */
+interface Deferral<R = void> {
+    /** Abort signal, if provided at construction. */
+    readonly signal?: AbortSignal;
+    /** Root promise instance. */
+    promise(): Promise<R>;
+    /** Internal resolve function. */
+    resolve(value: R): void;
+    /** Reject root promise. */
+    reject(reason?: string | Error | unknown): void;
+    /** Alias to await root promise. */
+    untilResolved(): Promise<R>;
+    /** Test if deferral has already been resolved or rejected. */
+    isComplete(): boolean;
+}
+
+/**
+ * Deferred Promise
+ *
+ * @remarks
+ * Allows extraction of a root promise's resolve/reject methods to use
+ * outside the promise context.
+ *
+ * @public
+ */
+declare class DeferredPromise<R = void> implements Deferral<R> {
+    #private;
+    /**
+     * Constructor.
+     *
+     * @param signal - Optional abort signal to reject root promise.
+     *
+     * @public
+     */
+    constructor(signal?: AbortSignal);
+    /**
+     * Exposes any provided abort signal.
+     *
+     * @public
+     */
+    get signal(): AbortSignal | undefined;
+    /**
+     * Returns root promise.
+     *
+     * @public
+     */
+    promise(): Promise<R>;
+    /**
+     * Resolves root promise.
+     *
+     * @param result - Any typed result.
+     *
+     * @public
+     */
+    resolve(result: R): void;
+    /**
+     * Rejects root promise.
+     *
+     * @param reason - Any string message or error instance.
+     *
+     * @public
+     */
+    reject(reason: string | Error | unknown): void;
+    /**
+     * Alias to await root promise.
+     *
+     * @public
+     */
+    untilResolved(): Promise<R>;
+    /**
+     * Checks root promise state.
+     *
+     * @public
+     */
+    isComplete(): boolean;
+}
+
+/**
+ * Provide a Deferred Promise instance.
+ *
+ * @param signal - Optional abort signal to reject root promise.
+ *
+ * @public
+ */
+declare const defer: <R = void>(signal?: AbortSignal) => Deferral<R>;
+
+export { Deferral, DeferredPromise, Rejection, Resolver, defer };

dist/index.js

@@ -1,7 +0,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./deferral"), exports);
-tslib_1.__exportStar(require("./provider"), exports);
-tslib_1.__exportStar(require("./types"), exports);
-//# sourceMappingURL=index.js.map
+'use strict';
+
+var i=class{#e;#r;#o;#n;#i=!1;constructor(e){this.#e=e,e==null||e.addEventListener("abort",this.#t.bind(this),{once:!0}),this.#r=new Promise((t,r)=>{this.#o=t,this.#n=r;});}get signal(){return this.#e}promise(){return this.#r}resolve(e){this.#s(e);}reject(e){this.#t(e);}async untilResolved(){return await this.#r}isComplete(){return this.#i}#s(e){var t,r;this.#i=!0,(t=this.#e)==null||t.removeEventListener("abort",this.#t.bind(this)),(r=this.#o)==null||r.call(this,e);}#t(e){var t,r;this.#i=!0,(t=this.#e)==null||t.removeEventListener("abort",this.#t.bind(this)),(r=this.#n)==null||r.call(this,e);}};var l=o=>new i(o);
+
+exports.DeferredPromise = i;
+exports.defer = l;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uL3NyYy9kZWZlcnJhbC50cyIsIi4uL3NyYy9wcm92aWRlci50cyJdLCJuYW1lcyI6WyJEZWZlcnJlZFByb21pc2UiLCIjc2lnbmFsIiwiI3Byb21pc2UiLCIjcmVzb2x2ZSIsIiNyZWplY3QiLCIjaXNDb21wbGV0ZSIsInNpZ25hbCIsIiNvblJlamVjdCIsInJlc29sdmUiLCJyZWplY3QiLCJyZXN1bHQiLCIjb25SZXNvbHZlIiwicmVhc29uIiwiX2EiLCJfYiIsImRlZmVyIl0sIm1hcHBpbmdzIjoiQUFXTyxJQUFNQSxFQUFOLEtBQXVELENBU25EQyxHQU9BQyxHQU9UQyxHQU9BQyxHQU9BQyxHQUF1QixHQVNoQixZQUFZQyxFQUFzQixDQUN2QyxLQUFLTCxHQUFVSyxFQUNmQSxHQUFBLE1BQUFBLEVBQVEsaUJBQWlCLFFBQVMsS0FBS0MsR0FBVSxLQUFLLElBQUksRUFBRyxDQUFFLEtBQU0sRUFBSyxHQUUxRSxLQUFLTCxHQUFXLElBQUksUUFBVyxDQUFDTSxFQUFTQyxJQUFXLENBQ2xELEtBQUtOLEdBQVdLLEVBQ2hCLEtBQUtKLEdBQVVLLENBQ2pCLENBQUMsQ0FDSCxDQU9BLElBQVcsUUFBa0MsQ0FDM0MsT0FBTyxLQUFLUixFQUNkLENBT08sU0FBc0IsQ0FDM0IsT0FBTyxLQUFLQyxFQUNkLENBU08sUUFBUVEsRUFBaUIsQ0FDOUIsS0FBS0MsR0FBV0QsQ0FBTSxDQUN4QixDQVNPLE9BQU9FLEVBQXdDLENBQ3BELEtBQUtMLEdBQVVLLENBQU0sQ0FDdkIsQ0FPQSxNQUFhLGVBQTRCLENBQ3ZDLE9BQU8sTUFBTSxLQUFLVixFQUNwQixDQU9PLFlBQXNCLENBQzNCLE9BQU8sS0FBS0csRUFDZCxDQVNBTSxHQUFXRCxFQUFpQixDQXBJOUIsSUFBQUcsRUFBQUMsRUFxSUksS0FBS1QsR0FBYyxJQUNuQlEsRUFBQSxLQUFLWixLQUFMLE1BQUFZLEVBQWMsb0JBQW9CLFFBQVMsS0FBS04sR0FBVSxLQUFLLElBQUksSUFDbkVPLEVBQUEsS0FBS1gsS0FBTCxNQUFBVyxFQUFBLFVBQWdCSixFQUNsQixDQVNBSCxHQUFVSyxFQUFnRCxDQWpKNUQsSUFBQUMsRUFBQUMsRUFrSkksS0FBS1QsR0FBYyxJQUNuQlEsRUFBQSxLQUFLWixLQUFMLE1BQUFZLEVBQWMsb0JBQW9CLFFBQVMsS0FBS04sR0FBVSxLQUFLLElBQUksSUFDbkVPLEVBQUEsS0FBS1YsS0FBTCxNQUFBVSxFQUFBLFVBQWVGLEVBQ2pCLENBQ0YsRUM1SU8sSUFBTUcsRUFBbUJULEdBQzlCLElBQUlOLEVBQW1CTSxDQUFNIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHR5cGUgeyBEZWZlcnJhbCwgUmVqZWN0aW9uLCBSZXNvbHZlciB9IGZyb20gXCIuL3R5cGVzXCJcblxuLyoqXG4gKiBEZWZlcnJlZCBQcm9taXNlXG4gKlxuICogQHJlbWFya3NcbiAqIEFsbG93cyBleHRyYWN0aW9uIG9mIGEgcm9vdCBwcm9taXNlJ3MgcmVzb2x2ZS9yZWplY3QgbWV0aG9kcyB0byB1c2VcbiAqIG91dHNpZGUgdGhlIHByb21pc2UgY29udGV4dC5cbiAqXG4gKiBAcHVibGljXG4gKi9cbmV4cG9ydCBjbGFzcyBEZWZlcnJlZFByb21pc2U8UiA9IHZvaWQ+IGltcGxlbWVudHMgRGVmZXJyYWw8Uj4ge1xuICAvKipcbiAgICogT3B0aW9uYWwgYWJvcnQgc2lnbmFsIHByb3ZpZGVkIGF0IGNvbnN0cnVjdGlvbi5cbiAgICpcbiAgICogQHJlbWFya3NcbiAgICogV2hlbiB0cmlnZ2VyZWQsIHdpbGwgcmVqZWN0IHJvb3QgcHJvbWlzZS5cbiAgICpcbiAgICogQGludGVybmFsXG4gICAqL1xuICByZWFkb25seSAjc2lnbmFsOiBBYm9ydFNpZ25hbCB8IHVuZGVmaW5lZFxuXG4gIC8qKlxuICAgKiBJbnRlcm5hbCByb290IHByb21pc2UgaW5zdGFuY2UuXG4gICAqXG4gICAqIEBpbnRlcm5hbFxuICAgKi9cbiAgcmVhZG9ubHkgI3Byb21pc2U6IFByb21pc2U8Uj5cblxuICAvKipcbiAgICogRXh0cmFjdGVkIHJlc29sdmUgbWV0aG9kLlxuICAgKlxuICAgKiBAaW50ZXJuYWxcbiAgICovXG4gICNyZXNvbHZlOiBSZXNvbHZlcjxSPiB8IHVuZGVmaW5lZFxuXG4gIC8qKlxuICAgKiBFeHRyYWN0ZWQgcmVqZWN0IG1ldGhvZC5cbiAgICpcbiAgICogQGludGVybmFsXG4gICAqL1xuICAjcmVqZWN0OiBSZWplY3Rpb24gfCB1bmRlZmluZWRcblxuICAvKipcbiAgICogVHJhY2tzIHByb21pc2Ugc3RhdGUuXG4gICAqXG4gICAqIEBpbnRlcm5hbFxuICAgKi9cbiAgI2lzQ29tcGxldGU6IGJvb2xlYW4gPSBmYWxzZVxuXG4gIC8qKlxuICAgKiBDb25zdHJ1Y3Rvci5cbiAgICpcbiAgICogQHBhcmFtIHNpZ25hbCAtIE9wdGlvbmFsIGFib3J0IHNpZ25hbCB0byByZWplY3Qgcm9vdCBwcm9taXNlLlxuICAgKlxuICAgKiBAcHVibGljXG4gICAqL1xuICBwdWJsaWMgY29uc3RydWN0b3Ioc2lnbmFsPzogQWJvcnRTaWduYWwpIHtcbiAgICB0aGlzLiNzaWduYWwgPSBzaWduYWxcbiAgICBzaWduYWw/LmFkZEV2ZW50TGlzdGVuZXIoXCJhYm9ydFwiLCB0aGlzLiNvblJlamVjdC5iaW5kKHRoaXMpLCB7IG9uY2U6IHRydWUgfSlcblxuICAgIHRoaXMuI3Byb21pc2UgPSBuZXcgUHJvbWlzZTxSPigocmVzb2x2ZSwgcmVqZWN0KSA9PiB7XG4gICAgICB0aGlzLiNyZXNvbHZlID0gcmVzb2x2ZVxuICAgICAgdGhpcy4jcmVqZWN0ID0gcmVqZWN0XG4gICAgfSlcbiAgfVxuXG4gIC8qKlxuICAgKiBFeHBvc2VzIGFueSBwcm92aWRlZCBhYm9ydCBzaWduYWwuXG4gICAqXG4gICAqIEBwdWJsaWNcbiAgICovXG4gIHB1YmxpYyBnZXQgc2lnbmFsKCk6IEFib3J0U2lnbmFsIHwgdW5kZWZpbmVkIHtcbiAgICByZXR1cm4gdGhpcy4jc2lnbmFsXG4gIH1cblxuICAvKipcbiAgICogUmV0dXJucyByb290IHByb21pc2UuXG4gICAqXG4gICAqIEBwdWJsaWNcbiAgICovXG4gIHB1YmxpYyBwcm9taXNlKCk6IFByb21pc2U8Uj4ge1xuICAgIHJldHVybiB0aGlzLiNwcm9taXNlXG4gIH1cblxuICAvKipcbiAgICogUmVzb2x2ZXMgcm9vdCBwcm9taXNlLlxuICAgKlxuICAgKiBAcGFyYW0gcmVzdWx0IC0gQW55IHR5cGVkIHJlc3VsdC5cbiAgICpcbiAgICogQHB1YmxpY1xuICAgKi9cbiAgcHVibGljIHJlc29sdmUocmVzdWx0OiBSKTogdm9pZCB7XG4gICAgdGhpcy4jb25SZXNvbHZlKHJlc3VsdClcbiAgfVxuXG4gIC8qKlxuICAgKiBSZWplY3RzIHJvb3QgcHJvbWlzZS5cbiAgICpcbiAgICogQHBhcmFtIHJlYXNvbiAtIEFueSBzdHJpbmcgbWVzc2FnZSBvciBlcnJvciBpbnN0YW5jZS5cbiAgICpcbiAgICogQHB1YmxpY1xuICAgKi9cbiAgcHVibGljIHJlamVjdChyZWFzb246IHN0cmluZyB8IEVycm9yIHwgdW5rbm93bik6IHZvaWQge1xuICAgIHRoaXMuI29uUmVqZWN0KHJlYXNvbilcbiAgfVxuXG4gIC8qKlxuICAgKiBBbGlhcyB0byBhd2FpdCByb290IHByb21pc2UuXG4gICAqXG4gICAqIEBwdWJsaWNcbiAgICovXG4gIHB1YmxpYyBhc3luYyB1bnRpbFJlc29sdmVkKCk6IFByb21pc2U8Uj4ge1xuICAgIHJldHVybiBhd2FpdCB0aGlzLiNwcm9taXNlXG4gIH1cblxuICAvKipcbiAgICogQ2hlY2tzIHJvb3QgcHJvbWlzZSBzdGF0ZS5cbiAgICpcbiAgICogQHB1YmxpY1xuICAgKi9cbiAgcHVibGljIGlzQ29tcGxldGUoKTogYm9vbGVhbiB7XG4gICAgcmV0dXJuIHRoaXMuI2lzQ29tcGxldGVcbiAgfVxuXG4gIC8qKlxuICAgKiBIYW5kbGVzIHJlc29sdmUgcHJvY2Vzcy5cbiAgICpcbiAgICogQHBhcmFtIHJlc3VsdCAtIEluY29taW5nIHJlc3VsdC5cbiAgICpcbiAgICogQGludGVybmFsXG4gICAqL1xuICAjb25SZXNvbHZlKHJlc3VsdDogUik6IHZvaWQge1xuICAgIHRoaXMuI2lzQ29tcGxldGUgPSB0cnVlXG4gICAgdGhpcy4jc2lnbmFsPy5yZW1vdmVFdmVudExpc3RlbmVyKFwiYWJvcnRcIiwgdGhpcy4jb25SZWplY3QuYmluZCh0aGlzKSlcbiAgICB0aGlzLiNyZXNvbHZlPy4ocmVzdWx0KVxuICB9XG5cbiAgLyoqXG4gICAqIEhhbmRsZXMgcmVqZWN0IHByb2Nlc3MuXG4gICAqXG4gICAqIEBwYXJhbSByZWFzb24gLSBNZXNzYWdlLCBlcnJvciwgb3IgYWJvcnQgZXZlbnQuXG4gICAqXG4gICAqIEBpbnRlcm5hbFxuICAgKi9cbiAgI29uUmVqZWN0KHJlYXNvbjogc3RyaW5nIHwgRXJyb3IgfCBFdmVudCB8IHVua25vd24pOiB2b2lkIHtcbiAgICB0aGlzLiNpc0NvbXBsZXRlID0gdHJ1ZVxuICAgIHRoaXMuI3NpZ25hbD8ucmVtb3ZlRXZlbnRMaXN0ZW5lcihcImFib3J0XCIsIHRoaXMuI29uUmVqZWN0LmJpbmQodGhpcykpXG4gICAgdGhpcy4jcmVqZWN0Py4ocmVhc29uKVxuICB9XG59XG4iLCJpbXBvcnQgeyBEZWZlcnJlZFByb21pc2UgfSBmcm9tIFwiLi9kZWZlcnJhbFwiXG5pbXBvcnQgdHlwZSB7IERlZmVycmFsIH0gZnJvbSBcIi4vdHlwZXNcIlxuXG4vKipcbiAqIFByb3ZpZGUgYSBEZWZlcnJlZCBQcm9taXNlIGluc3RhbmNlLlxuICpcbiAqIEBwYXJhbSBzaWduYWwgLSBPcHRpb25hbCBhYm9ydCBzaWduYWwgdG8gcmVqZWN0IHJvb3QgcHJvbWlzZS5cbiAqXG4gKiBAcHVibGljXG4gKi9cbmV4cG9ydCBjb25zdCBkZWZlciA9IDxSID0gdm9pZD4oc2lnbmFsPzogQWJvcnRTaWduYWwpOiBEZWZlcnJhbDxSPiA9PlxuICBuZXcgRGVmZXJyZWRQcm9taXNlPFI+KHNpZ25hbClcbiJdfQ==

package.json

 {
   "$schema": "https://json.schemastore.org/package",
   "name": "@nodesuite/defer",
-  "version": "0.3.31",
+  "version": "0.3.32",
   "description": "Deferred Promise resolution tools.",
@@ -47,4 +47,4 @@ "keywords": [
     "typescript": "4.9.5",
-    "@nodesuite/eslint-config": "0.3.31",
-    "@nodesuite/node-rig": "0.3.31"
+    "@nodesuite/eslint-config": "0.3.32",
+    "@nodesuite/node-rig": "0.3.32"
   },
@@ -51,0 +51,0 @@ "engines": {

No alert changes

Improved metrics

Total package byte prevSize

190316

increased by0.03%

Worsened metrics

Number of package files

39

decreased by-29.09%

Lines of code

1532

decreased by-11.45%

No dependency changes