From 0fc2bef0cd13922397b6090ce1e9821403364e24 Mon Sep 17 00:00:00 2001 From: Sonu Kapoor Date: Mon, 24 Aug 2020 17:36:57 -0400 Subject: [PATCH] docs(service-worker): add links to service worker communication guide (#36847) PR Close #36847 --- packages/service-worker/src/low_level.ts | 6 ++++++ packages/service-worker/src/update.ts | 2 ++ 2 files changed, 8 insertions(+) diff --git a/packages/service-worker/src/low_level.ts b/packages/service-worker/src/low_level.ts index 220e631cd6..25d2d1fcfa 100644 --- a/packages/service-worker/src/low_level.ts +++ b/packages/service-worker/src/low_level.ts @@ -14,6 +14,8 @@ export const ERR_SW_NOT_SUPPORTED = 'Service workers are disabled or not support /** * An event emitted when a new version of the app is available. * + * @see {@link guide/service-worker-communications Service worker communication guide} + * * @publicApi */ export interface UpdateAvailableEvent { @@ -25,6 +27,8 @@ export interface UpdateAvailableEvent { /** * An event emitted when a new version of the app has been downloaded and activated. * + * @see {@link guide/service-worker-communications Service worker communication guide} + * * @publicApi */ export interface UpdateActivatedEvent { @@ -42,6 +46,8 @@ export interface UpdateActivatedEvent { * service worker cache has been partially cleaned by the browser, removing some files of a previous * app version but not all. * + * @see {@link guide/service-worker-communications Service worker communication guide} + * * @publicApi */ export interface UnrecoverableStateEvent { diff --git a/packages/service-worker/src/update.ts b/packages/service-worker/src/update.ts index f9a8ad802a..59b9b0afca 100644 --- a/packages/service-worker/src/update.ts +++ b/packages/service-worker/src/update.ts @@ -17,6 +17,8 @@ import {ERR_SW_NOT_SUPPORTED, NgswCommChannel, UnrecoverableStateEvent, UpdateAc * Subscribe to update notifications from the Service Worker, trigger update * checks, and forcibly activate updates. * + * @see {@link guide/service-worker-communications Service worker communication guide} + * * @publicApi */ @Injectable()