voxolithRegisterServiceWorkerOptions
Options for registerServiceWorker.
Defined in: engine/src/pwa/register.ts:5
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
base? | string | The app's base URL (default import.meta.env.BASE_URL); the worker is <base><file>, scoped to <base>. | engine/src/pwa/register.ts:7 |
file? | string | The worker's file name, as given to the plugin (default sw.js). | engine/src/pwa/register.ts:9 |
localhost? | boolean | Register on localhost, 127.0.0.1 and [::1] too (default false), e.g. to try offline loading against vite preview. | engine/src/pwa/register.ts:14 |
Methods
onError()?
optional onError(error: unknown): void;Defined in: engine/src/pwa/register.ts:26
Registering failed (default: console.warn).
Parameters
| Parameter | Type |
|---|---|
error | unknown |
Returns
void
onOfflineReady()?
optional onOfflineReady(registration: ServiceWorkerRegistration): void;Defined in: engine/src/pwa/register.ts:19
The first worker for this app has installed and taken over: what it precaches is now cached, so the app loads offline from here on.
Parameters
| Parameter | Type |
|---|---|
registration | ServiceWorkerRegistration |
Returns
void
onUpdate()?
optional onUpdate(registration: ServiceWorkerRegistration): void;Defined in: engine/src/pwa/register.ts:24
A new build's worker has installed and taken over from an older one. The page still runs the old code; a reload runs the new build. Whether to say so is the app's call.
Parameters
| Parameter | Type |
|---|---|
registration | ServiceWorkerRegistration |
Returns
void