PeriodicSyncManager: register() method
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Want more browser support for this feature? Tell us why.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
Note: This feature is available in Web Workers.
The register() method of the
PeriodicSyncManager interface registers a periodic sync request with the
browser with the specified tag and options. It returns a Promise that
resolves when the registration completes.
The method requires the periodic-background-sync permission; see the API's security considerations for details.
Syntax
register(tag, options)
Parameters
tag-
A unique
Stringidentifier. optionsOptional-
An
Objectcontaining the following optional data:minInterval-
The minimum interval time, in milliseconds, at which the periodic sync should occur.
Return value
Exceptions
InvalidStateErrorDOMException-
Thrown if there is no active
ServiceWorkerpresent. NotAllowedErrorDOMException-
Thrown if the
periodic-background-syncpermission is not granted. InvalidAccessErrorDOMException-
Thrown if the active window is not the main window (not of
auxiliaryortop-leveltype).
Examples
The following asynchronous function registers a periodic background sync at a minimum interval of one day from a browsing context:
async function registerPeriodicNewsCheck() {
const registration = await navigator.serviceWorker.ready;
try {
await registration.periodicSync.register("fetch-news", {
minInterval: 24 * 60 * 60 * 1000,
});
} catch {
console.log("Periodic Sync could not be registered!");
}
}
Specifications
| Specification |
|---|
| Web Periodic Background Synchronization # dom-periodicsyncmanager-register |