@superutils/promise 1.0.6 → 1.0.9

package/README.md

@@ -2,7 +2,7 @@
 
 An extended `Promise` implementation, named `PromisE`, that provides additional features and utilities for easier asynchronous flow control in JavaScript and TypeScript applications.
 
-This package offers a drop-in replacement for the native `Promise` that includes status tracking (`.pending`, `.resolved`, `.rejected`) and a suite of powerful static methods for common asynchronous patterns like deferred execution, throttling, and cancellable fetches.
+This package offers a drop-in replacement for the native `Promise` that includes status tracking (`.pending`, `.resolved`, `.rejected`) and a suite of practical static methods for common asynchronous patterns like deferred execution, throttling, and cancellable fetches.
 
 <div v-if="false">
 

package/dist/index.d.ts

@@ -17,7 +17,7 @@ interface IPromisE<T = unknown> extends Promise<T> {
     /** Indicates if the promise has been resolved */
     readonly resolved: boolean;
 }
-interface IPromisE_Delay<T = unknown> extends IPromisE<T> {
+interface IPromisE_Delay<T = unknown> extends Promise<T>, IPromisE<T> {
     /**
      * Caution: pausing will prevent the promise from resolving/rejeting automatically.
      *
@@ -58,6 +58,7 @@ interface IPromisE_Delay<T = unknown> extends IPromisE<T> {
      * ```
      */
     pause: () => void;
+    /** Timeout ID */
     timeoutId: TimeoutId;
 }
 /**
@@ -122,8 +123,12 @@ type DeferredAsyncOptions<ThisArg = unknown, DelayMs extends number = number> =
 } & Omit<ThrottleOptions, 'onError' | 'ThisArg' | 'tid'>) | ({
     /** Debounce/deferred duration in milliseconds */
     delayMs?: PositiveNumber<DelayMs>;
-    throttle?: false | undefined;
-} & Omit<DeferredOptions, 'onError' | 'ThisArg' | 'tid'>));
+    throttle?: false;
+} & Omit<DeferredOptions, 'onError' | 'ThisArg' | 'tid'>) | {
+    /** Sequential execution. All promises will be executed sequentially making sure there is no overlap. */
+    delayMs: 0;
+    throttle?: false;
+});
 /** Determines what to do when deferred promise/function fails */
 declare enum ResolveError {
     /** Neither resolve nor reject the failed */
@@ -142,7 +147,7 @@ declare enum ResolveError {
 declare enum ResolveIgnored {
     /** Never resolve ignored promises. Caution: make sure this doesn't cause any memory leaks. */
     NEVER = "NEVER",
-    /** (default) resolve with active promise result, the one that caused the current promise/callback to be ignored).  */
+    /** (default) resolve with active promise result, the one that caused the current promise/callback to be ignored. */
     WITH_LAST = "WITH_LAST",
     /** resolve with `undefined` value */
     WITH_UNDEFINED = "WITH_UNDEFINED"
@@ -188,9 +193,9 @@ type RetryOptions<T = unknown> = {
 };
 
 declare class PromisEBase<T = unknown> extends Promise<T> implements IPromisE<T> {
-    readonly state: 0 | 1 | 2;
     private _resolve?;
     private _reject?;
+    private _state;
     /**
      * callbacks to be invoked whenever PromisE instance is finalized early using non-static resolve()/reject() methods */
     onEarlyFinalize: OnEarlyFinalize<T>[];
@@ -219,6 +224,8 @@ declare class PromisEBase<T = unknown> extends Promise<T> implements IPromisE<T>
     get rejected(): boolean;
     /** Indicates if the promise has been resolved */
     get resolved(): boolean;
+    /** Get promise status code */
+    get state(): 0 | 1 | 2;
     /** Resovle pending promise early. */
     resolve: (value: T | PromiseLike<T>) => void;
     /** Reject pending promise early. */

package/dist/index.js

@@ -9,7 +9,7 @@ import {
 } from "@superutils/core";
 
 // src/PromisEBase.ts
-import { asAny, fallbackIfFails, isFn, isPromise } from "@superutils/core";
+import { fallbackIfFails, isFn, isPromise } from "@superutils/core";
 var _PromisEBase = class _PromisEBase extends Promise {
   constructor(input) {
     if (input instanceof _PromisEBase) return input;
@@ -17,11 +17,11 @@ var _PromisEBase = class _PromisEBase extends Promise {
     let _reject;
     super((resolve, reject) => {
       _reject = (reason) => {
-        asAny(this).state = 2;
+        this._state = 2;
         reject(reason);
       };
       _resolve = (value) => {
-        asAny(this).state = 1;
+        this._state = 1;
         resolve(value);
       };
       input != null ? input : input = () => {
@@ -29,7 +29,7 @@ var _PromisEBase = class _PromisEBase extends Promise {
       const promise = isPromise(input) ? input : isFn(input) ? new globalThis.Promise(input) : Promise.resolve(input);
       promise.then(_resolve, _reject);
     });
-    this.state = 0;
+    this._state = 0;
     /**
      * callbacks to be invoked whenever PromisE instance is finalized early using non-static resolve()/reject() methods */
     this.onEarlyFinalize = [];
@@ -66,15 +66,19 @@ var _PromisEBase = class _PromisEBase extends Promise {
   //
   /** Indicates if the promise is still pending/unfinalized */
   get pending() {
-    return this.state === 0;
+    return this._state === 0;
   }
   /** Indicates if the promise has been rejected */
   get rejected() {
-    return this.state === 2;
+    return this._state === 2;
   }
   /** Indicates if the promise has been resolved */
   get resolved() {
-    return this.state === 1;
+    return this._state === 1;
+  }
+  /** Get promise status code */
+  get state() {
+    return this._state;
   }
   // static withResolvers = <T = unknown>() => {
   // 	const pwr = globalThis.Promise.withResolvers<T>()
@@ -165,9 +169,14 @@ var ResolveIgnored = /* @__PURE__ */ ((ResolveIgnored2) => {
 })(ResolveIgnored || {});
 
 // src/deferred.ts
-function deferred(options) {
+function deferred(options = {}) {
   const { defaults } = deferred;
-  options = objCopy(defaults, options, [], "empty");
+  options = objCopy(
+    defaults,
+    options,
+    [],
+    "empty"
+  );
   let { onError, onIgnore, onResult } = options;
   const {
     delayMs,
@@ -247,7 +256,7 @@ function deferred(options) {
     return deferFn(execute2, delayMs, options);
   })();
   const deferredFunc = (promise) => {
-    const id = Symbol("deferred-queue-item-id");
+    const id = /* @__PURE__ */ Symbol("deferred-queue-item-id");
     const qItem = new PromisEBase_default();
     qItem.getPromise = isFn2(promise) ? promise : () => promise;
     qItem.started = false;

package/package.json

@@ -4,7 +4,7 @@
 		"url": "https://github.com/alien45/superutils/issues"
 	},
 	"dependencies": {
-		"@superutils/core": "^1.0.5"
+		"@superutils/core": "^1.0.8"
 	},
 	"description": "An extended Promise with extra features such as status tracking, deferred/throttled execution, timeout and retry mechanism.",
 	"files": [
@@ -23,7 +23,7 @@
 	"main": "dist/index.js",
 	"name": "@superutils/promise",
 	"peerDpendencies": {
-		"@superutils/core": "^1.0.5"
+		"@superutils/core": "^1.0.8"
 	},
 	"publishConfig": {
 		"access": "public"
@@ -43,5 +43,5 @@
 	"sideEffects": false,
 	"type": "module",
 	"types": "dist/index.d.ts",
-	"version": "1.0.6"
+	"version": "1.0.9"
 }