Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes #30419 | cleanup Service Worker API summary #30659

Merged
merged 8 commits into from
Dec 5, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 16 additions & 11 deletions files/en-us/web/api/service_worker_api/index.md
Original file line number Diff line number Diff line change
@@ -101,27 +101,24 @@ In the future, service workers will be able to do a number of other useful thing
- : The parameter passed into the {{DOMxRef("ServiceWorkerGlobalScope.install_event", "oninstall")}} handler, the `InstallEvent` interface represents an install action that is dispatched on the {{DOMxRef("ServiceWorkerGlobalScope")}} of a {{DOMxRef("ServiceWorker")}}. As a child of {{DOMxRef("ExtendableEvent")}}, it ensures that functional events such as {{DOMxRef("FetchEvent")}} are not dispatched during installation.
- {{DOMxRef("NavigationPreloadManager")}}
- : Provides methods for managing the preloading of resources with a service worker.
- {{DOMxRef("Navigator.serviceWorker")}}
- : Returns a {{DOMxRef("ServiceWorkerContainer")}} object, which provides access to registration, removal, upgrade, and communication with the {{DOMxRef("ServiceWorker")}} objects for the [associated document](https://html.spec.whatwg.org/multipage/browsers.html#concept-document-window).
- {{DOMxRef("NotificationEvent")}}
- : The parameter passed into the {{DOMxRef("ServiceWorkerGlobalScope.notificationclick_event", "onnotificationclick")}} handler, the `NotificationEvent` interface represents a notification click event that is dispatched on the {{DOMxRef("ServiceWorkerGlobalScope")}} of a {{DOMxRef("ServiceWorker")}}.
- {{DOMxRef("ServiceWorker")}}
- : Represents a service worker. Multiple browsing contexts (e.g. pages, workers, etc.) can be associated with the same `ServiceWorker` object.
- {{DOMxRef("ServiceWorkerContainer")}}
- : Provides an object representing the service worker as an overall unit in the network ecosystem, including facilities to register, unregister, and update service workers, and access the state of service workers and their registrations.
- {{DOMxRef("ServiceWorkerGlobalScope")}}
- : Represents the global execution context of a service worker.
- {{DOMxRef("MessageEvent")}}
- : Represents a message sent to a {{DOMxRef("ServiceWorkerGlobalScope")}}.
- {{DOMxRef("ServiceWorkerRegistration")}}
- : Represents a service worker registration.
- {{DOMxRef("SyncEvent")}} {{Experimental_Inline}}
- : The SyncEvent interface represents a sync action that is dispatched on the {{DOMxRef("ServiceWorkerGlobalScope")}} of a ServiceWorker.
- {{DOMxRef("SyncManager")}} {{Experimental_Inline}}
- : Provides an interface for registering and listing sync registrations.
- {{DOMxRef("WindowClient")}}
- : Represents the scope of a service worker client that is a document in a browser context, controlled by an active worker. This is a special type of {{DOMxRef("Client")}} object, with some additional methods and properties available.

### Extensions to other interfaces

- {{DOMxRef("Navigator.serviceWorker")}}
- : Returns a {{DOMxRef("ServiceWorkerContainer")}} object, which provides access to registration, removal, upgrade, and communication with the {{DOMxRef("ServiceWorker")}} objects for the [associated document](https://html.spec.whatwg.org/multipage/browsers.html#concept-document-window).
- {{DOMxRef("WorkerNavigator.serviceWorker")}}
- : Returns a {{DOMxRef("ServiceWorkerContainer")}} object, which provides access to registration, removal, upgrade, and communication with the {{DOMxRef("ServiceWorker")}} objects for the [associated document](https://html.spec.whatwg.org/multipage/browsers.html#concept-document-window).

## Specifications

{{Specifications}}
@@ -132,4 +129,12 @@ In the future, service workers will be able to do a number of other useful thing
- [Using Service Workers](/en-US/docs/Web/API/Service_Worker_API/Using_Service_Workers)
- [Service workers basic code example](https://github.com/mdn/dom-examples/tree/main/service-worker/simple-service-worker)
- [Is ServiceWorker ready?](https://jakearchibald.github.io/isserviceworkerready/)
- {{jsxref("Promise")}}
- Web APIs that are related to the Service Worker API:
- {{domxref("Background Fetch API", "", "", "nocode")}}
- {{domxref("Background Synchronization API", "", "", "nocode")}}
- {{domxref("Content Index API", "", "", "nocode")}}
- {{domxref("Cookie Store API", "", "", "nocode")}}
- {{domxref("Notifications API", "", "", "nocode")}}
- {{domxref("Payment Handler API", "", "", "nocode")}}
- {{domxref("Push API", "", "", "nocode")}}
- {{domxref("Web Periodic Background Synchronization API", "", "", "nocode")}}
11 changes: 5 additions & 6 deletions files/jsondata/GroupData.json
Original file line number Diff line number Diff line change
@@ -1253,21 +1253,20 @@
"Client",
"Clients",
"ExtendableEvent",
"ExtendableMessageEvent",
"FetchEvent",
"InstallEvent",
"NotificationEvent",
"PeriodicSyncEvent",
"PeriodicSyncManager",
"ServiceWorker",
"ServiceWorkerContainer",
"ServiceWorkerGlobalScope",
"ServiceWorkerRegistration",
"SyncEvent",
"SyncManager",
"WindowClient"
],
"methods": [],
"properties": ["Navigator.serviceWorker"],
"properties": [
"Navigator.serviceWorker",
"WorkerNavigator.serviceWorker"
],
"events": []
},
"Speculation Rules API": {