# register-service-worker

> Script for registering service worker, with hooks

Latest version **1.7.2** (published 2020-12-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install register-service-worker
pnpm add register-service-worker
yarn add register-service-worker
bun add register-service-worker
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.7.2 |
| Published | 2020-12-10 |
| First published | 2018-01-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 20.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 659 |
| Author | Evan You |
| Maintainers | yyx990803, soda, ulivz |
| Keywords | service-worker |

## Links

- npm: https://www.npmjs.com/package/register-service-worker
- Repository: https://github.com/yyx990803/register-service-worker
- Homepage: https://github.com/yyx990803/register-service-worker#readme
- Issues: https://github.com/yyx990803/register-service-worker/issues
- npm.io page: https://npm.io/package/register-service-worker

## Alternatives

- [cron](https://npm.io/package/cron.md) — 4.9M weekly downloads
- [@vercel/queue](https://npm.io/package/@vercel/queue.md) — 731.6K weekly downloads
- [create-sonicjs](https://npm.io/package/create-sonicjs.md) — 1.6K weekly downloads
- [@exellix/jobs-api](https://npm.io/package/@exellix/jobs-api.md) — 941 weekly downloads
- [@forwardimpact/libskill](https://npm.io/package/@forwardimpact/libskill.md) — 575 weekly downloads

## Recent versions

- 1.7.2 (latest) — 2020-12-10
- 1.7.1 — 2020-03-19
- 1.7.0 — 2020-03-10
- 1.6.2 — 2019-02-18
- 1.6.1 — 2019-02-11
- 1.6.0 — 2019-02-08
- 1.5.2 — 2018-08-16
- 1.5.1 — 2018-08-13
- 1.5.0 — 2018-08-13
- 1.4.1 — 2018-06-18
- 1.4.0 — 2018-06-01
- 1.3.0 — 2018-05-28
- 1.2.0 — 2018-04-13
- 1.1.1 — 2018-02-12
- 1.1.0 — 2018-01-11
- … 1 more at https://npm.io/package/register-service-worker/versions

## README

# 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.

``` js
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](https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration) instance in their arguments.

The `registrationOptions` object will be passed as the second argument to [`ServiceWorkerContainer.register()`](https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerContainer/register#Parameters)

---
_Source: https://npm.io/package/register-service-worker · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._