docs(plugin-pwa): add jsdoc and improve docs

plugins/pwa/plugin-pwa/src/client/composables/setupPwa.ts

@@ -5,6 +5,14 @@ import { pwaEventSymbol } from './usePwaEvent.js'
 import { useRegisterSW } from './useRegisterSW.js'
 import type { PwaEvent } from './index.js'
 
+/**
+ * Setup PWA functionality
+ *
+ * 设置 PWA 功能
+ *
+ * @param serviceWorkerPath - Service Worker path / Service Worker 路径
+ * @param shouldForceUpdate - Whether to force update / 是否强制更新
+ */
 export const setupPwa = (
   serviceWorkerPath: string,
   shouldForceUpdate = false,

plugins/pwa/plugin-pwa/src/client/composables/setupViewPoint.ts

@@ -1,5 +1,10 @@
 import { onMounted } from 'vue'
 
+/**
+ * Setup viewport for PWA standalone mode
+ *
+ * 为 PWA 独立模式设置视口
+ */
 export const setupViewPoint = (): void => {
   onMounted(() => {
     const isStandAlone = window.matchMedia('(display-mode: standalone)').matches

plugins/pwa/plugin-pwa/src/client/composables/usePwaEvent.ts

@@ -18,6 +18,13 @@ export const pwaEventSymbol: InjectionKey<PwaEvent> = Symbol(
   __VUEPRESS_DEV__ ? 'PwaEvent' : '',
 )
 
+/**
+ * Use PWA event emitter
+ *
+ * 使用 PWA 事件发射器
+ *
+ * @returns PWA event emitter / PWA 事件发射器
+ */
 export const usePwaEvent = (): PwaEvent => {
   const pwaEvent = inject(pwaEventSymbol)
 

plugins/pwa/plugin-pwa/src/client/composables/useRegisterSW.ts

@@ -2,6 +2,15 @@ import { withBase } from 'vuepress/client'
 import { registerSW } from '../utils/index.js'
 import type { PwaEvent } from './usePwaEvent.js'
 
+/**
+ * Register service worker with event emitter
+ *
+ * 使用事件发射器注册 Service Worker
+ *
+ * @param serviceWorkerPath - Service Worker path / Service Worker 路径
+ * @param event - PWA event emitter / PWA 事件发射器
+ * @returns Promise that resolves when registration is complete / 注册完成时解析的 Promise
+ */
 export const useRegisterSW = async (
   serviceWorkerPath: string,
   event: PwaEvent,

plugins/pwa/plugin-pwa/src/client/utils/registerSW.ts

@@ -4,15 +4,11 @@ import type { Hooks } from 'register-service-worker'
 /**
  * Register serviceWorker under `serviceWorkerPath`
  *
- * @param serviceWorkerPath Service Worker path
- * @param hooks Service worker hooks
- * @param showStatus Whether to show status in console
- *
  * 在 `serviceWorkerPath` 下注册 Service Worker
  *
- * @param serviceWorkerPath Service Worker 路径
- * @param hooks Service Worker 钩子
- * @param showStatus 是否在控制台显示状态
+ * @param serviceWorkerPath - Service Worker path / Service Worker 路径
+ * @param hooks - Service worker hooks / Service Worker 钩子
+ * @param showStatus - Whether to show status in console / 是否在控制台显示状态
  */
 export const registerSW = async (
   serviceWorkerPath: string,

plugins/pwa/plugin-pwa/src/client/utils/skipWaiting.ts

@@ -2,6 +2,8 @@
  * Call `skipWaiting()` inside current waiting worker
  *
  * 在当前等待中的 Service Worker 中调用 `skipWaiting()`
+ *
+ * @param registration - The registration of the service worker you want activate / 想要激活的 Service Worker 的注册
  */
 export const skipWaiting = (registration: ServiceWorkerRegistration): void => {
   // Get the waiting worker

plugins/pwa/plugin-pwa/src/client/utils/unregisterSW.ts

@@ -2,11 +2,9 @@
 /**
  * Call `unregister()` inside current active worker
  *
- * @returns `true` if unregister success, `false` if unregister failed
- *
  * 在当前激活的 Service Worker 中调用 `unregister()`
  *
- * @returns `true` 表示注销成功，`false` 表示注销失败
+ * @returns `true` if unregister success, `false` if unregister failed / `true` 表示注销成功，`false` 表示注销失败
  */
 export const unregisterSW = (): Promise<boolean> =>
   navigator.serviceWorker

plugins/pwa/plugin-pwa/src/node/pwaPlugin.ts

@@ -13,6 +13,31 @@ import { PLUGIN_NAME, logger } from './logger.js'
 import type { PwaPluginOptions } from './options.js'
 import { prepareClientConfigFile } from './prepareClientConfigFile.js'
 
+/**
+ * PWA plugin
+ *
+ * PWA 插件
+ *
+ * @param options - Plugin options / 插件选项
+ * @returns VuePress plugin / VuePress 插件
+ *
+ * @example
+ * ```ts
+ * import { pwaPlugin } from '@vuepress/plugin-pwa'
+ *
+ * export default {
+ *   plugins: [
+ *     pwaPlugin({
+ *       showInstall: true,
+ *       manifest: {
+ *         name: 'My PWA App'
+ *       },
+ *       update: 'hint'
+ *     })
+ *   ]
+ * }
+ * ```
+ */
 export const pwaPlugin =
   (options: PwaPluginOptions = {}): PluginFunction =>
   (app) => {