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

Jump to bottom

feat(client): add on begin update hooks #623

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
+41 −5
Open

feat(client): add on begin update hooks #623

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
59ccbb3
feat(register): add on begin update hooks
Doctor-wu Dec 14, 2023
7ba5603
feat(example): add on begin update hooks example
Doctor-wu Dec 14, 2023
e055948
feat(examples & register): use update found to detect new version
Doctor-wu Dec 14, 2023
495f5ea
chore(register): delete useless comment
Doctor-wu Dec 15, 2023
0c777f8
feat(examples): delete unnecessary computed
Doctor-wu Dec 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/client/build/preact.ts
View file
Open in desktop
Expand Up @@ -8,6 +8,7 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
const {
immediate = true,
onNeedRefresh,
onBeginUpdate,
onOfflineReady,
onRegistered,
onRegisteredSW,
Expand All @@ -24,6 +25,7 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
setOfflineReady(true)
onOfflineReady?.()
},
onBeginUpdate,
onNeedRefresh() {
setNeedRefresh(true)
onNeedRefresh?.()
Expand Down
2 changes: 2 additions & 0 deletions src/client/build/react.ts
View file
Open in desktop
Expand Up @@ -8,6 +8,7 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
const {
immediate = true,
onNeedRefresh,
onBeginUpdate,
onOfflineReady,
onRegistered,
onRegisteredSW,
Expand All @@ -24,6 +25,7 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
setOfflineReady(true)
onOfflineReady?.()
},
onBeginUpdate,
onNeedRefresh() {
setNeedRefresh(true)
onNeedRefresh?.()
Expand Down
6 changes: 6 additions & 0 deletions src/client/build/register.ts
View file
Open in desktop
Expand Up @@ -18,6 +18,7 @@ export function registerSW(options: RegisterSWOptions = {}) {
const {
immediate = false,
onNeedRefresh,
onBeginUpdate,
onOfflineReady,
onRegistered,
onRegisteredSW,
Expand Down Expand Up @@ -81,6 +82,11 @@ export function registerSW(options: RegisterSWOptions = {}) {

onNeedRefresh?.()
}
// Add an event listener to detect when the new service worker
// start to be installed but not yet installed.
Doctor-wu marked this conversation as resolved.
Show resolved Hide resolved
wb.addEventListener('installing', (event) => {
event.isUpdate && onBeginUpdate?.()
})
wb.addEventListener('installed', (event) => {
if (typeof event.isUpdate === 'undefined') {
if (typeof event.isExternal !== 'undefined') {
Expand Down
2 changes: 2 additions & 0 deletions src/client/build/solid.ts
View file
Open in desktop
Expand Up @@ -8,6 +8,7 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
const {
immediate = true,
onNeedRefresh,
onBeginUpdate,
onOfflineReady,
onRegistered,
onRegisteredSW,
Expand All @@ -19,6 +20,7 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {

const updateServiceWorker = registerSW({
immediate,
onBeginUpdate,
onOfflineReady() {
setOfflineReady(true)
onOfflineReady?.()
Expand Down
2 changes: 2 additions & 0 deletions src/client/build/svelte.ts
View file
Open in desktop
Expand Up @@ -8,6 +8,7 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
const {
immediate = true,
onNeedRefresh,
onBeginUpdate,
onOfflineReady,
onRegistered,
onRegisteredSW,
Expand All @@ -19,6 +20,7 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {

const updateServiceWorker = registerSW({
immediate,
onBeginUpdate,
onOfflineReady() {
offlineReady.set(true)
onOfflineReady?.()
Expand Down
2 changes: 2 additions & 0 deletions src/client/build/vue.ts
View file
Open in desktop
Expand Up @@ -8,6 +8,7 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
const {
immediate = true,
onNeedRefresh,
onBeginUpdate,
onOfflineReady,
onRegistered,
onRegisteredSW,
Expand All @@ -19,6 +20,7 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {

const updateServiceWorker = registerSW({
immediate,
onBeginUpdate,
onNeedRefresh() {
needRefresh.value = true
onNeedRefresh?.()
Expand Down
1 change: 1 addition & 0 deletions src/client/type.d.ts
View file
Open in desktop
@@ -1,6 +1,7 @@
export interface RegisterSWOptions {
immediate?: boolean
onNeedRefresh?: () => void
onBeginUpdate?: () => void
onOfflineReady?: () => void
/**
* Called only if `onRegisteredSW` is not provided.
Expand Down