Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(types): include $pwa module augmentation types for Nuxt and Vue #2462

Closed
wants to merge 2 commits into from
Closed

chore(types): include $pwa module augmentation types for Nuxt and Vue #2462

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4291721
chore(types): fix `$pwa` module augmentation types for Nuxt and Vue
userquin Nov 8, 2023
755a584
chore: use `#app` instead `#app/nuxt`
userquin Nov 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions modules/pwa/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,33 @@
import type { VitePWAOptions } from 'vite-plugin-pwa'
import { type Ref, type UnwrapNestedRefs } from 'vue'

export interface VitePWANuxtOptions extends Partial<VitePWAOptions> {}

export interface PwaInjection {
isInstalled: boolean
showInstallPrompt: Ref<boolean>
cancelInstall: () => void
install: () => Promise<void>
swActivated: Ref<boolean>
registrationError: Ref<boolean>
needRefresh: Ref<boolean>
updateServiceWorker: (reloadPage?: boolean | undefined) => Promise<void>
close: () => Promise<void>
}

// TODO: we'll need to review this to '#app/nuxt'
declare module '#app' {
interface NuxtApp {
$pwa: UnwrapNestedRefs<PwaInjection>
}
}

declare module '@vue/runtime-core' {
export interface ComponentCustomProperties {
$pwa: UnwrapNestedRefs<PwaInjection>
}
}

declare module '@nuxt/schema' {
interface NuxtConfig {
pwa?: { [K in keyof VitePWANuxtOptions]?: Partial<VitePWANuxtOptions[K]> }
Expand Down
Loading