32 lines
1.1 KiB
TypeScript
32 lines
1.1 KiB
TypeScript
declare module 'virtual:pwa-register/vue' {
|
|
// @ts-expect-error ignore when vue is not installed
|
|
import type { Ref } from 'vue';
|
|
|
|
export interface RegisterSWOptions {
|
|
immediate?: boolean;
|
|
onNeedRefresh?: () => void;
|
|
onOfflineReady?: () => void;
|
|
/**
|
|
* Called only if `onRegisteredSW` is not provided.
|
|
*
|
|
* @deprecated Use `onRegisteredSW` instead.
|
|
* @param registration The service worker registration if available.
|
|
*/
|
|
onRegistered?: (registration: ServiceWorkerRegistration | undefined) => void;
|
|
/**
|
|
* Called once the service worker is registered (requires version `0.12.8+`).
|
|
*
|
|
* @param swScriptUrl The service worker script url.
|
|
* @param registration The service worker registration if available.
|
|
*/
|
|
onRegisteredSW?: (swScriptUrl: string, registration: ServiceWorkerRegistration | undefined) => void;
|
|
onRegisterError?: (error: any) => void;
|
|
}
|
|
|
|
export function useRegisterSW(options?: RegisterSWOptions): {
|
|
needRefresh: Ref<boolean>;
|
|
offlineReady: Ref<boolean>;
|
|
updateServiceWorker: (reloadPage?: boolean) => Promise<void>;
|
|
};
|
|
}
|