Elgato_dark/angular
1
0
Fork 0
mirror of https://github.com/angular/angular synced 2026-05-24 09:28:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: improve discoverability in service worker documentation

Browse source 
(cherry picked from commit dde18c2303)
This commit is contained in:
SkyZeroZx 2025-11-10 14:02:18 -05:00 committed by Andrew Kushnir
parent e0407c0fe3
commit c59fa8b85a
4 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
packages/service-worker/src/low_level.ts
View file

@ -109,7 +109,7 @@ export type VersionEvent =
* service worker cache has been partially cleaned by the browser, removing some files of a previous
* app version but not all.
*
* @see {@link /ecosystem/service-workers/communications Service Worker Communication Guide}
* @see [Handling an unrecoverable state](ecosystem/service-workers/communications#handling-an-unrecoverable-state)
*
* @publicApi

4
packages/service-worker/src/module.ts
View file

@ -13,6 +13,10 @@ import {SwPush} from './push';
import {SwUpdate} from './update';
/**
*
* @see [Custom service worker script](ecosystem/service-workers/custom-service-worker-scripts)
* @see [Service worker configuration](ecosystem/service-workers/getting-started#service-worker-configuration)
*
* @publicApi
*/
@NgModule({providers: [SwPush, SwUpdate]})

4
packages/service-worker/src/push.ts
View file

@ -89,6 +89,7 @@ import {ERR_SW_NOT_SUPPORTED, NgswCommChannel, PushEvent} from './low_level';
* @see [MDN: Push API](https://developer.mozilla.org/en-US/docs/Web/API/Push_API)
* @see [MDN: Notifications API](https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API)
* @see [MDN: Web Push API Notifications best practices](https://developer.mozilla.org/en-US/docs/Web/API/Push_API/Best_Practices)
* @see [Push notifications guide](ecosystem/service-workers/push-notifications)
*
* @publicApi
*/
@ -109,6 +110,9 @@ export class SwPush {
* object that also includes the `title` of the [Notification][Mozilla Notification] object.
*
* [Mozilla Notification]: https://developer.mozilla.org/en-US/docs/Web/API/Notification
*
* @see [Notification click handling](ecosystem/service-workers/push-notifications#notification-click-handling)
*
*/
readonly notificationClicks: Observable<{
action: string;

3
packages/service-worker/src/update.ts
View file

@ -35,6 +35,9 @@ export class SwUpdate {
*
* Emits a `VersionReadyEvent` event whenever a new version has been downloaded and is ready for
* activation.
*
* @see [Version updates](ecosystem/service-workers/communications#version-updates)
*
*/
readonly versionUpdates: Observable<VersionEvent>;