feat: allow extending the type of definePage()

posva · Feb 16, 2023 · 4d663b1 · 4d663b1
1 parent a39afae
commit 4d663b1
Showing 1 changed file with 9 additions and 3 deletions.
diff --git a/src/runtime.ts b/src/runtime.ts
@@ -16,9 +16,7 @@ export { stopScope as _stopDataFetchingScope } from './data-fetching/dataCache'
  *
  * @param route - route information to be added to this page
  */
-export const _definePage = (
-  route: Partial<Omit<RouteRecordRaw, 'children' | 'components' | 'component'>>
-) => route
+export const _definePage = (route: DefinePage) => route
 
 /**
  * Merges route records.
@@ -50,3 +48,11 @@ export function _mergeRouteRecord(
     return acc
   }, main)
 }
+
+/**
+ * Type to define a page. Can be augmented to add custom properties.
+ */
+export interface DefinePage
+  extends Partial<
+    Omit<RouteRecordRaw, 'children' | 'components' | 'component'>
+  > {}