serviceworkers

Register, unregister, and message service workers via the Service Worker API.

Import: @rtorcato/browser-common/serviceworkers

📖 MDN: Service Worker API · 📊 caniuse: serviceworkers

Registering a service worker needs a secure context (HTTPS/localhost).

Browser support

API	Chrome	Edge	Firefox	Safari	iOS Safari	Baseline
ServiceWorkerContainer.register	✅ 40+	✅ 17+	✅ 44+	✅ 11.1+	✅ 11.3+	Widely available

✅ supported · ◐ partial · ❌ not supported · [n] see note. Generated from MDN browser-compat-data and web-features. caniuse: ServiceWorkerContainer.register

Example

import {
  isServiceWorkerAvailable,
  registerServiceWorker,
  postMessageToServiceWorker,
} from '@rtorcato/browser-common/serviceworkers'

if (isServiceWorkerAvailable()) {
  const reg = await registerServiceWorker('/sw.js', { scope: '/' })
  postMessageToServiceWorker({ type: 'skipWaiting' })
}

Exports

• isServiceWorkerAvailable() — feature check
• registerServiceWorker(scriptUrl, options?) — registers a service worker, resolves to the ServiceWorkerRegistration or undefined
• unregisterAllServiceWorkers() — unregisters every service worker for the current origin
• getServiceWorkerRegistration() — resolves to the active ServiceWorkerRegistration, or undefined
• postMessageToServiceWorker(message) — sends a message to the active service worker

See the API reference for full signatures.