Improve the types relating to the Deferred class used in tests.

Author: jaydenseric

LoadingCacheValue.test.mjs

@@ -123,7 +123,8 @@ export default (tests) => {
     loading.addEventListener(`${cacheKey}/end`, loadingListener);
 
     const { promise: loadingResult, resolve: loadingResultResolve } =
-      new Deferred();
+      /** @type {Deferred<Readonly<Record<string, unknown>>>} */
+      (new Deferred());
     const abortController = new AbortController();
     const loadingCacheValue = new LoadingCacheValue(
       loading,
@@ -204,7 +205,9 @@ export default (tests) => {
       const {
         promise: firstLoadingResult,
         resolve: firstLoadingResultResolve,
-      } = new Deferred();
+      } =
+        /** @type {Deferred<Readonly<Record<string, unknown>>>} */
+        (new Deferred());
       const firstAbortController = new AbortController();
       const firstLoadingCacheValue = new LoadingCacheValue(
         loading,
@@ -242,7 +245,9 @@ export default (tests) => {
       const {
         promise: secondLoadingResult,
         resolve: secondLoadingResultResolve,
-      } = new Deferred();
+      } =
+        /** @type {Deferred<Readonly<Record<string, unknown>>>} */
+        (new Deferred());
       const secondAbortController = new AbortController();
       const secondLoadingCacheValue = new LoadingCacheValue(
         loading,
@@ -369,7 +374,9 @@ export default (tests) => {
       const {
         promise: firstLoadingResult,
         resolve: firstLoadingResultResolve,
-      } = new Deferred();
+      } =
+        /** @type {Deferred<Readonly<Record<string, unknown>>>} */
+        (new Deferred());
       const firstAbortController = new AbortController();
       const firstLoadingCacheValue = new LoadingCacheValue(
         loading,
@@ -407,7 +414,9 @@ export default (tests) => {
       const {
         promise: secondLoadingResult,
         resolve: secondLoadingResultResolve,
-      } = new Deferred();
+      } =
+        /** @type {Deferred<Readonly<Record<string, unknown>>>} */
+        (new Deferred());
       const secondAbortController = new AbortController();
       const secondLoadingCacheValue = new LoadingCacheValue(
         loading,

changelog.md

@@ -16,6 +16,7 @@
 - Simplified dev dependencies and config for ESLint.
 - Fixed issues with GraphQL result related types from `types.mjs`.
 - Improved various JSDoc descriptions.
+- Improved the types relating to the `Deferred` class used in tests.
 
 ## 17.0.0
 

test/Deferred.mjs

@@ -2,20 +2,19 @@
 
 /**
  * Deferred promise that can be externally resolved or rejected.
- * @template T
+ * @template [Resolves=void] What the promise resolves.
  */
 export default class Deferred {
   constructor() {
-    /**
-     * The promise.
-     * @type {Promise<T>}
-     */
-    this.promise = new Promise((resolve, reject) => {
-      /** Resolves the promise. */
-      this.resolve = resolve;
+    /** The promise. */
+    this.promise = /** @type {Promise<Resolves>} */ (
+      new Promise((resolve, reject) => {
+        /** Resolves the promise. */
+        this.resolve = resolve;
 
-      /** Rejects the promise. */
-      this.reject = reject;
-    });
+        /** Rejects the promise. */
+        this.reject = reject;
+      })
+    );
   }
 }

useLoadingEntry.test.mjs

@@ -119,7 +119,8 @@ export default (tests) => {
         strictEqual(result.error, undefined);
 
         const { promise: loadingA1Result, resolve: loadingA1ResultResolve } =
-          new Deferred();
+          /** @type {Deferred<Readonly<Record<string, unknown>>>} */
+          (new Deferred());
 
         /** @type {LoadingCacheValue | undefined} */
         let loadingA1CacheValue;
@@ -156,7 +157,8 @@ export default (tests) => {
         strictEqual(result.error, undefined);
 
         const { promise: loadingB1Result, resolve: loadingB1ResultResolve } =
-          new Deferred();
+          /** @type {Deferred<Readonly<Record<string, unknown>>>} */
+          (new Deferred());
 
         /** @type {LoadingCacheValue | undefined} */
         let loadingB1CacheValue;
@@ -197,7 +199,8 @@ export default (tests) => {
         const cache = new Cache();
         const cacheKeyA = "a";
         const { promise: loadingA1Result, resolve: loadingA1ResultResolve } =
-          new Deferred();
+          /** @type {Deferred<Readonly<Record<string, unknown>>>} */
+          (new Deferred());
         const loadingA1CacheValue = new LoadingCacheValue(
           loading,
           cache,
@@ -229,7 +232,8 @@ export default (tests) => {
         strictEqual(result.error, undefined);
 
         const { promise: loadingA2Result, resolve: loadingA2ResultResolve } =
-          new Deferred();
+          /** @type {Deferred<Readonly<Record<string, unknown>>>} */
+          (new Deferred());
 
         /** @type {LoadingCacheValue | undefined} */
         let loadingA2CacheValue;
@@ -271,7 +275,8 @@ export default (tests) => {
 
         const cacheKeyB = "b";
         const { promise: loadingB1Result, resolve: loadingB1ResultResolve } =
-          new Deferred();
+          /** @type {Deferred<Readonly<Record<string, unknown>>>} */
+          (new Deferred());
 
         /** @type {LoadingCacheValue | undefined} */
         let loadingB1CacheValue;