• Overview
@angular/service-worker

SwUpdate

Class

Subscribe to update notifications from the Service Worker, trigger update checks, and forcibly activate updates.

  
    class SwUpdate {}
  
  

versionUpdates

Observable<VersionEvent>

Emits a VersionDetectedEvent event whenever a new version is detected on the server.

Emits a VersionInstallationFailedEvent event whenever checking for or downloading a new version fails.

Emits a VersionReadyEvent event whenever a new version has been downloaded and is ready for activation.

unrecoverable

Emits an UnrecoverableStateEvent event whenever the version of the app used by the service worker to serve this client is in a broken state that cannot be recovered from without a full page reload.

isEnabled

boolean

True if the Service Worker is enabled (supported by the browser and enabled via ServiceWorkerModule).

checkForUpdate

Promise<boolean>

Checks for an update and waits until the new version is downloaded from the server and ready for activation.

@returnsPromise<boolean>

activateUpdate

Promise<boolean>

Updates the current client (i.e. browser tab) to the latest version that is ready for activation.

In most cases, you should not use this method and instead should update a client by reloading the page.

Updating a client without reloading can easily result in a broken application due to a version mismatch between the application shell and other page resources, such as lazy-loaded chunks, whose filenames may change between versions.

Only use this method, if you are certain it is safe for your specific use case.

@returnsPromise<boolean>
Jump to details