Skip to content

Commit c59fa8b

Browse files
SkyZeroZxAndrewKushnir
authored andcommitted
docs: improve discoverability in service worker documentation
(cherry picked from commit dde18c2)
1 parent e0407c0 commit c59fa8b

File tree

4 files changed

+12
-1
lines changed

4 files changed

+12
-1
lines changed

packages/service-worker/src/low_level.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ export type VersionEvent =
109109
* service worker cache has been partially cleaned by the browser, removing some files of a previous
110110
* app version but not all.
111111
*
112-
* @see {@link /ecosystem/service-workers/communications Service Worker Communication Guide}
112+
* @see [Handling an unrecoverable state](ecosystem/service-workers/communications#handling-an-unrecoverable-state)
113113
114114
*
115115
* @publicApi

packages/service-worker/src/module.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ import {SwPush} from './push';
1313
import {SwUpdate} from './update';
1414

1515
/**
16+
*
17+
* @see [Custom service worker script](ecosystem/service-workers/custom-service-worker-scripts)
18+
* @see [Service worker configuration](ecosystem/service-workers/getting-started#service-worker-configuration)
19+
*
1620
* @publicApi
1721
*/
1822
@NgModule({providers: [SwPush, SwUpdate]})

packages/service-worker/src/push.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ import {ERR_SW_NOT_SUPPORTED, NgswCommChannel, PushEvent} from './low_level';
8989
* @see [MDN: Push API](https://developer.mozilla.org/en-US/docs/Web/API/Push_API)
9090
* @see [MDN: Notifications API](https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API)
9191
* @see [MDN: Web Push API Notifications best practices](https://developer.mozilla.org/en-US/docs/Web/API/Push_API/Best_Practices)
92+
* @see [Push notifications guide](ecosystem/service-workers/push-notifications)
9293
*
9394
* @publicApi
9495
*/
@@ -109,6 +110,9 @@ export class SwPush {
109110
* object that also includes the `title` of the [Notification][Mozilla Notification] object.
110111
*
111112
* [Mozilla Notification]: https://developer.mozilla.org/en-US/docs/Web/API/Notification
113+
*
114+
* @see [Notification click handling](ecosystem/service-workers/push-notifications#notification-click-handling)
115+
*
112116
*/
113117
readonly notificationClicks: Observable<{
114118
action: string;

packages/service-worker/src/update.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ export class SwUpdate {
3535
*
3636
* Emits a `VersionReadyEvent` event whenever a new version has been downloaded and is ready for
3737
* activation.
38+
*
39+
* @see [Version updates](ecosystem/service-workers/communications#version-updates)
40+
*
3841
*/
3942
readonly versionUpdates: Observable<VersionEvent>;
4043

0 commit comments

Comments
 (0)