VersionReadyEvent UpdateInfo Property

Which @angular/* package(s) are relevant/releated to the feature request?

service-worker

Description

Regarding VersionReadyEvent’s currentVersion and latestVersion objects, is it possible to have them contain a new property updateInfo: string so that we can use this updateInfo to customize or set the update notification text?

interface VersionReadyEvent { type: ‘VERSION_READY’ currentVersion: {…} latestVersion: {…} }

https://angular.io/api/service-worker/SwUpdate

import {filter, map} from 'rxjs/operators';
// ...
const updatesAvailable = swUpdate.versionUpdates.pipe(
  filter((evt): evt is [VersionReadyEvent](https://angular.io/api/service-worker/VersionReadyEvent) => evt.type === 'VERSION_READY'),
  map(evt => ({
    type: 'UPDATE_AVAILABLE',
    current: evt.currentVersion,
    available: evt.latestVersion,
  })));

Proposed solution

Regarding VersionReadyEvent’s currentVersion and latestVersion objects, is it possible to have them contain a new property updateInfo: string so that we can use this updateInfo to customize or set the update notification text?

Alternatives considered

Create an extra endpoint to set the update text

[gkalpak]

That’s a great idea, @Jun711 👍 Would you be up to creating a PR to update the docs? Alternatively, maybe you could create a GitHub issue to track this.

[Jun711]

@gkalpak Thank you, it works. I suggest adding a link to SW Configuration page or creating a description page that describes what appData is so that users who read VersionReadyEvent and related pages can figure out what appData is without having to search