refactor: use enum for DeferredPromise status

Signed-off-by: Trae Yelovich <[email protected]>
zowe · Dec 27, 2024 · fd55a0f · fd55a0f
1 parent 3dc39b1
commit fd55a0f
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 8 deletions.
diff --git a/packages/zowe-explorer-api/__tests__/__unit__/utils/DeferredPromise.unit.test.ts b/packages/zowe-explorer-api/__tests__/__unit__/utils/DeferredPromise.unit.test.ts
@@ -9,7 +9,7 @@
  *
  */
 
-import { DeferredPromise } from "../../../src";
+import { DeferredPromise, DeferredPromiseStatus } from "../../../src";
 
 describe("DeferredPromise constructor", () => {
     it("sets resolve and reject functions", () => {
@@ -23,13 +23,13 @@ describe("DeferredPromise constructor", () => {
 describe("DeferredPromise.status", () => {
     it("returns pending when not yet resolved", () => {
         const deferred = new DeferredPromise();
-        expect(deferred.status).toBe("pending");
+        expect(deferred.status).toBe(DeferredPromiseStatus.Pending);
     });
 
     it("returns fulfilled when resolved", () => {
         const deferred = new DeferredPromise();
         deferred.resolve(null);
-        expect(deferred.status).toBe("fulfilled");
+        expect(deferred.status).toBe(DeferredPromiseStatus.Fulfilled);
     });
 
     it("returns rejected when rejected", async () => {
@@ -41,7 +41,7 @@ describe("DeferredPromise.status", () => {
         } catch (err) {
             errorCaught = true;
         }
-        expect(deferred.status).toBe("rejected");
+        expect(deferred.status).toBe(DeferredPromiseStatus.Rejected);
         expect(errorCaught).toBe(true);
     });
 });
diff --git a/packages/zowe-explorer-api/src/utils/DeferredPromise.ts b/packages/zowe-explorer-api/src/utils/DeferredPromise.ts
@@ -10,7 +10,11 @@
  */
 
 /* Status of the deferred promise */
-export type DeferredPromiseStatus = "pending" | "fulfilled" | "rejected";
+export enum DeferredPromiseStatus {
+    Pending = "pending",
+    Fulfilled = "fulfilled",
+    Rejected = "rejected",
+}
 
 /**
  * @brief Externally control the resolution and rejection of a promise.
@@ -21,7 +25,7 @@ export type DeferredPromiseStatus = "pending" | "fulfilled" | "rejected";
  * the promise's outcome depends on factors outside the immediate context.
  */
 export class DeferredPromise<T> {
-    private mStatus: DeferredPromiseStatus = "pending";
+    private mStatus: DeferredPromiseStatus = DeferredPromiseStatus.Pending;
 
     public promise: Promise<T>;
     public resolve: (value: T | PromiseLike<T>) => void;
@@ -30,11 +34,11 @@ export class DeferredPromise<T> {
     public constructor() {
         this.promise = new Promise<T>((resolve, reject) => {
             this.resolve = (value): void => {
-                this.mStatus = "fulfilled";
+                this.mStatus = DeferredPromiseStatus.Fulfilled;
                 resolve(value);
             };
             this.reject = (err): void => {
-                this.mStatus = "rejected";
+                this.mStatus = DeferredPromiseStatus.Rejected;
                 reject(err);
             };
         });