Skip to main content

@rtorcato/browser-common / serviceworkers

serviceworkers

Functions​

isServiceWorkerAvailable()​

isServiceWorkerAvailable(): boolean

Defined in: serviceworkers/index.ts:10

Checks if Service Workers are available in the current browser.

Returns​

boolean

True if available, false otherwise.

Example​

import { isServiceWorkerAvailable } from '@rtorcato/browser-common/serviceworkers'
if (isServiceWorkerAvailable()) register()

registerServiceWorker()​

registerServiceWorker(scriptUrl, options?): Promise<ServiceWorkerRegistration | undefined>

Defined in: serviceworkers/index.ts:25

Registers a service worker script.

Parameters​

scriptUrl​

string

The URL of the service worker script.

options?​

RegistrationOptions

Optional ServiceWorkerRegistration options.

Returns​

Promise<ServiceWorkerRegistration | undefined>

The registration or undefined if not supported.

Example​

import { registerServiceWorker } from '@rtorcato/browser-common/serviceworkers'
const reg = await registerServiceWorker('/sw.js', { scope: '/' })

unregisterAllServiceWorkers()​

unregisterAllServiceWorkers(): Promise<boolean>

Defined in: serviceworkers/index.ts:46

Unregisters all service workers for the current origin.

Returns​

Promise<boolean>

True if all were unregistered, false otherwise.

Example​

import { unregisterAllServiceWorkers } from '@rtorcato/browser-common/serviceworkers'
await unregisterAllServiceWorkers()

getServiceWorkerRegistration()​

getServiceWorkerRegistration(): Promise<ServiceWorkerRegistration | undefined>

Defined in: serviceworkers/index.ts:62

Gets the current active service worker registration, if any.

Returns​

Promise<ServiceWorkerRegistration | undefined>

The registration or undefined.

Example​

import { getServiceWorkerRegistration } from '@rtorcato/browser-common/serviceworkers'
const reg = await getServiceWorkerRegistration()

postMessageToServiceWorker()​

postMessageToServiceWorker(message): void

Defined in: serviceworkers/index.ts:79

Sends a message to the active service worker.

Parameters​

message​

unknown

The message to send.

Returns​

void

Example​

import { postMessageToServiceWorker } from '@rtorcato/browser-common/serviceworkers'
postMessageToServiceWorker({ type: 'skipWaiting' })