refactor: add PageDataPayload type (#742)

vuejs · Jun 9, 2022 · 8bf4182 · 8bf4182
1 parent 421f641
commit 8bf4182
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 7 deletions.
diff --git a/src/client/app/index.ts b/src/client/app/index.ts
@@ -15,6 +15,7 @@ import { usePrefetch } from './composables/preFetch'
 import { dataSymbol, initData } from './data'
 import { Content } from './components/Content'
 import { ClientOnly } from './components/ClientOnly'
+import { PageDataPayload } from '../shared'
 
 const NotFound = Theme.NotFound || (() => '404 Not Found')
 
@@ -119,15 +120,15 @@ function handleHMR(router: Router): void {
   // update route.data on HMR updates of active page
   if (import.meta.hot) {
     // hot reload pageData
-    import.meta.hot!.on('vitepress:pageData', (payload) => {
+    import.meta.hot!.on('vitepress:pageData', (payload: PageDataPayload) => {
       if (shouldHotReload(payload)) {
         router.route.data = payload.pageData
       }
     })
   }
 }
 
-function shouldHotReload(payload: any): boolean {
+function shouldHotReload(payload: PageDataPayload): boolean {
   const payloadPath = payload.path.replace(/(\bindex)?\.md$/, '')
   const locationPath = location.pathname.replace(/(\bindex)?\.html$/, '')
 

diff --git a/src/node/plugin.ts b/src/node/plugin.ts
@@ -6,6 +6,7 @@ import { DIST_CLIENT_PATH, APP_PATH, SITE_DATA_REQUEST_PATH } from './alias'
 import { slash } from './utils/slash'
 import { OutputAsset, OutputChunk } from 'rollup'
 import { staticDataPlugin } from './staticDataPlugin'
+import { PageDataPayload } from './shared'
 
 type Awaited<T> = T extends Promise<infer P> ? P : never
 
@@ -262,14 +263,16 @@ export async function createVitePressPlugin(
           config.publicDir
         )
 
+        const payload: PageDataPayload = {
+          path: `/${slash(path.relative(srcDir, file))}`,
+          pageData
+        }
+
         // notify the client to update page data
         server.ws.send({
           type: 'custom',
           event: 'vitepress:pageData',
-          data: {
-            path: `/${slash(path.relative(srcDir, file))}`,
-            pageData
-          }
+          data: payload
         })
 
         // overwrite src so vue plugin can handle the HMR

diff --git a/src/shared/shared.ts b/src/shared/shared.ts
@@ -6,7 +6,8 @@ export type {
   HeadConfig,
   LocaleConfig,
   Header,
-  DefaultTheme
+  DefaultTheme,
+  PageDataPayload
 } from '../../types/shared'
 
 export const EXTERNAL_URL_RE = /^https?:/i

diff --git a/types/shared.d.ts b/types/shared.d.ts
@@ -72,3 +72,8 @@ export interface LocaleConfig {
   label?: string
   selectText?: string
 }
+
+export interface PageDataPayload {
+  path: string
+  pageData: PageData
+}