SyncManager: register() method
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Note: This feature is available in Web Workers.
The register() method of the SyncManager interface registers a synchronization event, triggering a sync event inside the associated service worker as soon as network connectivity is available.
Syntax
js
register(tag)
Parameters
Return value
Exceptions
InvalidStateErrorDOMException-
Thrown if current service worker is not active.
NotAllowedErrorDOMException-
Thrown if background sync has been disabled by the user.
Examples
The following asynchronous function registers a background sync from a browsing context:
js
async function syncMessagesLater() {
const registration = await navigator.serviceWorker.ready;
try {
await registration.sync.register("sync-messages");
} catch {
console.log("Background Sync could not be registered!");
}
}
Specifications
| Specification |
|---|
| Web Background Synchronization # dom-syncmanager-register |
Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
register
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
- See implementation notes.