register-service-worker

by yyx990803

A script to simplify service worker registration with hooks for common events.

475 Stars 49 Forks Last release: 7 months ago (v1.7.1) MIT License 54 Commits 5 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

register-service-worker

A script to simplify service worker registration with hooks for common events.

Usage

Note: this script uses ES modules export and is expected to be used with a client side bundler that can handle ES modules syntax.

import { register } from 'register-service-worker'

register('/service-worker.js', { registrationOptions: { scope: './' }, ready (registration) { console.log('Service worker is active.') }, registered (registration) { console.log('Service worker has been registered.') }, cached (registration) { console.log('Content has been cached for offline use.') }, updatefound (registration) { console.log('New content is downloading.') }, updated (registration) { console.log('New content is available; please refresh.') }, offline () { console.log('No internet connection found. App is running in offline mode.') }, error (error) { console.error('Error during service worker registration:', error) } })

The

ready
,
registered
,
cached
,
updatefound
and
updated
events passes a ServiceWorkerRegistration instance in their arguments.

The

registrationOptions
object will be passed as the second argument to
ServiceWorkerContainer.register()

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.