Merge pull request #14 from tobimori/patch-1

fix type error when registering custom transitions and/or renderers
craftedbygc · Jun 1, 2023 · 19237aa · 19237aa
2 parents 5cf8d30 + 1e6b81c
commit 19237aa
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 18 deletions.
diff --git a/src/Core.d.ts b/src/Core.d.ts
@@ -1,7 +1,7 @@
 /**
  * @typedef CacheEntry
  * @type {object}
- * @property {Renderer} renderer
+ * @property {typeof Renderer} renderer
  * @property {Document|Node} page
  * @property {array} scripts
  * @property {boolean} skipCache
@@ -15,8 +15,8 @@ export default class Core {
      * 		removeOldContent?: boolean,
      * 		allowInterruption?: boolean,
      * 		bypassCache?: boolean,
-     * 		renderers?: Object.<string, Renderer>,
-     * 		transitions?: Object.<string, Transition>,
+     * 		renderers?: Object.<string, typeof Renderer>,
+     * 		transitions?: Object.<string, typeof Transition>,
      * 		reloadJsFilter?: boolean|function(HTMLElement): boolean
      * }} parameters
      */
@@ -26,34 +26,30 @@ export default class Core {
         allowInterruption?: boolean;
         bypassCache?: boolean;
         renderers?: {
-            [x: string]: Renderer;
+            [x: string]: typeof Renderer;
         };
         transitions?: {
-            [x: string]: Transition;
+            [x: string]: typeof Transition;
         };
         reloadJsFilter?: boolean | ((arg0: HTMLElement) => boolean);
     });
     isTransitioning: boolean;
     /**
      * @type {CacheEntry|null}
      */
-    currentCacheEntry: CacheEntry | null;
+    currentCacheEntry: CacheEntry;
     /**
      * @type {Map<string, CacheEntry>}
      */
     cache: Map<string, CacheEntry>;
     renderers: {
-        [x: string]: Renderer;
-    } | {
-        default: typeof Renderer;
+        [x: string]: typeof Renderer;
     };
     transitions: {
-        [x: string]: Transition;
-    } | {
-        default: typeof Transition;
+        [x: string]: typeof Transition;
     };
-    defaultRenderer: Renderer | typeof Renderer;
-    defaultTransition: Transition | typeof Transition;
+    defaultRenderer: typeof Renderer;
+    defaultTransition: typeof Transition;
     wrapper: Element;
     reloadJsFilter: boolean | ((element: HTMLElement) => boolean);
     removeOldContent: boolean;
@@ -193,7 +189,7 @@ export default class Core {
     private createCacheEntry;
 }
 export type CacheEntry = {
-    renderer: Renderer;
+    renderer: typeof Renderer;
     page: Document | Node;
     scripts: any[];
     skipCache: boolean;

diff --git a/src/Core.js b/src/Core.js
@@ -9,7 +9,7 @@ const IN_PROGRESS = 'A transition is currently in progress'
 /**
  * @typedef CacheEntry
  * @type {object}
- * @property {Renderer} renderer
+ * @property {typeof Renderer} renderer
  * @property {Document|Node} page
  * @property {array} scripts
  * @property {boolean} skipCache
@@ -36,8 +36,8 @@ export default class Core {
 	 * 		removeOldContent?: boolean,
 	 * 		allowInterruption?: boolean,
 	 * 		bypassCache?: boolean,
-	 * 		renderers?: Object.<string, Renderer>,
-	 * 		transitions?: Object.<string, Transition>,
+	 * 		renderers?: Object.<string, typeof Renderer>,
+	 * 		transitions?: Object.<string, typeof Transition>,
 	 * 		reloadJsFilter?: boolean|function(HTMLElement): boolean
 	 * }} parameters
 	 */