PeriodicSyncEvent: PeriodicSyncEvent() constructor

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

See full compatibility

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

Note: This feature is only available in Service Workers.

The PeriodicSyncEvent() constructor creates a new PeriodicSyncEvent object. This constructor is not typically used. The browser creates these objects itself and provides them to onperiodicsync callback.

Syntax

new PeriodicSyncEvent(type, options)

Parameters

type

A string with the name of the event. It is case-sensitive and browsers set it to periodicsync.

options

An object that, in addition of the properties defined in Event(), can have the following properties:

tag: The tag referencing the sync event.

Return value

A new PeriodicSyncEvent object configured using the given inputs.

Examples

This example constructs a new PeriodicSyncEvent with the relevant associated tag.

const psEvent = new ExtendableEvent("periodicsync", { tag: "unique-tag" });

Specifications

Specification
Web Periodic Background Synchronization # dom-periodicsyncevent-periodicsyncevent

Browser compatibility

	desktop					mobile
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on iOS	Samsung Internet	WebView Android	WebView on iOS
`PeriodicSyncEvent()` constructor Experimental	Chrome – Full support Chrome 80 (Release date: 2020-02-04) footnote Full support	Edge – Full support Edge 80 (Release date: 2020-02-07) footnote Full support	Firefox – No support Firefox footnote No support	Opera – Full support Opera 67 (Release date: 2020-03-03) footnote Full support	Safari – No support Safari footnote No support	Chrome Android – Full support Chrome Android 80 (Release date: 2020-02-04) footnote Full support	Firefox for Android – No support Firefox for Android footnote No support	Opera Android – Full support Opera Android 57 (Release date: 2020-03-30) footnote Full support	Safari on iOS – No support Safari on iOS footnote No support	Samsung Internet – Full support Samsung Internet 13 (Release date: 2020-12-02) footnote Full support	WebView Android – No support WebView Android footnote No support	WebView on iOS – No support WebView on iOS footnote No support

Tip: you can click/tap on a cell for more information.

Full support: Full support
No support: No support
: Experimental. Expect behavior to change in the future.