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

Adapt ServiceWorker API to new events structure #13923

Merged
merged 3 commits into from
Mar 16, 2022
Merged
Show file tree
Hide file tree
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
4 changes: 3 additions & 1 deletion files/en-us/_redirects.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9063,9 +9063,11 @@
/en-US/docs/Web/API/Serial/ondisconnect /en-US/docs/Web/API/SerialPort/disconnect_event
/en-US/docs/Web/API/SerialPort/onconnect /en-US/docs/Web/API/SerialPort/connect_event
/en-US/docs/Web/API/SerialPort/ondisconnect /en-US/docs/Web/API/SerialPort/disconnect_event
/en-US/docs/Web/API/ServiceWorker.onstatechange /en-US/docs/Web/API/ServiceWorker/onstatechange
/en-US/docs/Web/API/ServiceWorker.onstatechange /en-US/docs/Web/API/ServiceWorker/statechange_event
/en-US/docs/Web/API/ServiceWorker.scriptURL /en-US/docs/Web/API/ServiceWorker/scriptURL
/en-US/docs/Web/API/ServiceWorker.state /en-US/docs/Web/API/ServiceWorker/state
/en-US/docs/Web/API/ServiceWorker/onerror /en-US/docs/Web/API/ServiceWorker/error_event
/en-US/docs/Web/API/ServiceWorker/onstatechange /en-US/docs/Web/API/ServiceWorker/statechange_event
/en-US/docs/Web/API/ServiceWorkerClient /en-US/docs/Web/API/Client
/en-US/docs/Web/API/ServiceWorkerClient/focus /en-US/docs/Web/API/WindowClient/focus
/en-US/docs/Web/API/ServiceWorkerClient/postMessage /en-US/docs/Web/API/Client/postMessage
Expand Down
14 changes: 7 additions & 7 deletions files/en-us/_wikihistory.json
Original file line number Diff line number Diff line change
Expand Up @@ -74675,8 +74675,8 @@
"Meggin"
]
},
"Web/API/ServiceWorker/onstatechange": {
"modified": "2020-10-15T21:32:16.664Z",
"Web/API/ServiceWorker/scriptURL": {
"modified": "2020-10-15T21:32:15.265Z",
"contributors": [
"sideshowbarker",
"jpmedley",
Expand All @@ -74687,24 +74687,24 @@
"kscarfone"
]
},
"Web/API/ServiceWorker/scriptURL": {
"modified": "2020-10-15T21:32:15.265Z",
"Web/API/ServiceWorker/state": {
"modified": "2020-10-15T21:32:13.917Z",
"contributors": [
"sideshowbarker",
"jpmedley",
"mfluehr",
"fscholz",
"abbycar",
"chrisdavidmills",
"Sebastianz",
"kscarfone"
]
},
"Web/API/ServiceWorker/state": {
"modified": "2020-10-15T21:32:13.917Z",
"Web/API/ServiceWorker/statechange_event": {
"modified": "2020-10-15T21:32:16.664Z",
"contributors": [
"sideshowbarker",
"jpmedley",
"mfluehr",
"fscholz",
"abbycar",
"chrisdavidmills",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,27 +1,35 @@
---
title: ServiceWorker.onerror
slug: Web/API/ServiceWorker/onerror
title: 'ServiceWorker: error event'
slug: Web/API/ServiceWorker/error_event
tags:
- API
- ServiceWorker
- EventHandler
- Property
- Reference
- Web Workers
queengooborg marked this conversation as resolved.
Show resolved Hide resolved
- Workers
- onerror
queengooborg marked this conversation as resolved.
Show resolved Hide resolved
browser-compat: api.ServiceWorker.onerror
- Event
browser-compat: api.ServiceWorker.error_event
---
{{APIRef("Service Workers API")}}

The **`onerror`** property of the {{domxref("ServiceWorker")}} interface represents an [event handler](/en-US/docs/Web/Events/Event_handlers), that is a function to be called when the {{event("error")}} event occurs.
The `error` event fires whenever an error occurs in the service worker.

## Syntax

Use the event name in methods like {{domxref("EventTarget.addEventListener", "addEventListener()")}}, or set an event handler property.

```js
myServiceWorker.onerror = function(event) { /* ... */ };
addEventListener('error', event => { });

onerror = event => { };
```

## Event type

A generic {{domxref("Event")}}.

## Example

The following code snippet gets a handle to the {{domxref("ServiceWorker")}} object via {{domxref("ServiceWorkerRegistration.active")}} and sets up an `onerror` handler on the resulting object:
Expand Down
10 changes: 5 additions & 5 deletions files/en-us/web/api/serviceworker/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ _The `ServiceWorker` interface inherits properties from its parent, {{domxref("E
- {{domxref("ServiceWorker.state")}} {{readonlyinline}}
- : Returns the state of the service worker. It returns one of the following values: `installing`, `installed,` `activating`, `activated`, or `redundant`.

### Event handlers

- {{domxref("ServiceWorker.onstatechange")}} {{readonlyinline}}
- : An {{domxref("EventListener")}} property called whenever an event of type `statechange` is fired; it is basically fired anytime the {{domxref("ServiceWorker.state")}} changes.

## Methods

_The `ServiceWorker` interface inherits methods from its parent, {{domxref("EventTarget")}}._

## Events

- {{domxref("ServiceWorker.statechange_event", "statechange")}} {{readonlyinline}}
- : Fires anytime the {{domxref("ServiceWorker.state")}} changes.

## Examples

This code snippet is from the [service worker registration-events sample](https://github.com/GoogleChrome/samples/blob/gh-pages/service-worker/registration-events/index.html) ([live demo](https://googlechrome.github.io/samples/service-worker/registration-events/)). The code listens for any change in the {{domxref("ServiceWorker.state")}} and returns its value.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,28 +1,33 @@
---
title: ServiceWorker.onstatechange
slug: Web/API/ServiceWorker/onstatechange
title: 'ServiceWorker: statechange event'
slug: Web/API/ServiceWorker/statechange_event
tags:
- API
- Property
- Event
- Reference
- Service Workers
- ServiceWorker
- onstatechange
browser-compat: api.ServiceWorker.onstatechange
- statechange
browser-compat: api.ServiceWorker.statechange_event
---
{{APIRef("Service Workers API")}}

An {{domxref("EventListener")}} property called whenever an event of type
`statechange` is fired; it is basically fired anytime the
{{domxref("ServiceWorker.state")}} changes.
The `statechange` event fires anytime the {{domxref("ServiceWorker.state")}} changes.

## Syntax

Use the event name in methods like {{domxref("EventTarget.addEventListener", "addEventListener()")}}, or set an event handler property.

```js
ServiceWorker.onstatechange = function(statechangeevent) { /* ... */ }
ServiceWorker.addEventListener('statechange', function(statechangeevent) { /* ... */ } )
addEventListener('statechange', event => { });

onstatechange = event => { };
```

## Event type

A generic {{domxref("Event")}}.

## Examples

This code snippet is from the [service
Expand Down