Git Product home page Git Product logo

sw-periodic-sync's Introduction

serviceWorker Periodic Synchronization

Just a "polyfill" solution for the serviceWorker periodicSync. This code adding to the ServiceWorkerRegistration object prototype the periodicSync method if not available.

This code is not complete yet, I just created and tested as a possible solution but I need to add moarh code for true "polyfill" solution. I accept pull request if you have time and like this until the platform does it a better way!

Sample usage when registering serviceWorker

navigator.serviceWorker.register('serviceWorker.js').then(swRegistration => {
	swRegistration.periodicSync.register({
		tag: 'something',
		powerState: 'auto',
		networkState: 'online',
		allowOnBattery: true,
		idleRequired: false,
		maxDelay: 60000,
		minDelay: 5000,
		minPeriod: 20000
	});
});

Sample usage after registering serviceWorker

navigator.serviceWorker.ready.then(swRegistration => {
	swRegistration.periodicSync.register({
		tag: 'something',
		powerState: 'auto',
		networkState: 'online',
		allowOnBattery: true,
		idleRequired: false,
		maxDelay: 60000,
		minDelay: 5000,
		minPeriod: 20000
	});
});

Synchronization event

When the periodicSync is fired the script will trigger a global event which is named after the registered periodic sync in this format: sync-<tag>

document.addEventListener('sync-something', function(event) {
	// do stuff...
});

Unregister a synchronization

navigator.serviceWorker.ready.then(swRegistration => {
	swRegistration.periodicSync.getRegistration('something').then(registration => {
		registration.unregister();
	});
});

Change a synchronization

The register will always delete the previnous synchronization settings and use the new one using the tag as a key.

"Documentation"

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.