https://github.com/afeiship/sw-runtime
Service worker runtime for workbox.
https://github.com/afeiship/sw-runtime
active cache cli install pwa service-worker sw workbox
Last synced: 3 months ago
JSON representation
Service worker runtime for workbox.
- Host: GitHub
- URL: https://github.com/afeiship/sw-runtime
- Owner: afeiship
- License: mit
- Created: 2024-01-18T23:33:34.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-16T04:40:40.000Z (10 months ago)
- Last Synced: 2025-02-07T13:24:29.198Z (5 months ago)
- Topics: active, cache, cli, install, pwa, service-worker, sw, workbox
- Language: TypeScript
- Homepage:
- Size: 45.9 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# sw-runtime
> Service worker runtime for workbox.
[![version][version-image]][version-url]
[![license][license-image]][license-url]
[![size][size-image]][size-url]
[![download][download-image]][download-url]
## installation
```shell
npm install @jswork/sw-runtime
```
## skipWaiting
```js
// case1: skipWaiting true: will be update immediately
module.exports = {
maximumFileSizeToCacheInBytes: 100 * 1024 * 1024,
globDirectory: 'build/',
globPatterns: ['**/*.{js,png,json,txt,css,map}'],
globIgnores: ['*/fallback.js'],
skipWaiting: true,
clientsClaim: true,
//...
};
// case2: skipWaiting false: will be update when you click sw-tips `reload` button
module.exports = {
maximumFileSizeToCacheInBytes: 100 * 1024 * 1024,
globDirectory: 'build/',
globPatterns: ['**/*.{js,png,json,txt,css,map}'],
globIgnores: ['*/fallback.js'],
skipWaiting: false,
clientsClaim: false,
//...
};
```
## usage
```js
import SwRuntime from '@jswork/sw-runtime';
// App Did Mount, config sw
window.onload = function () {
SwRuntime.install({
autoUpdate: true,
autoUpdateInterval: 5 * 1000,
onAutoUpdate: function () {
console.log('SW Event:', 'onAutoUpdate');
},
onUpdateReady: function ({ context }) {
console.log('SW Event:', 'onUpdateReady');
setTimeout(function () {
console.log('SW Event:', 'do applyUpdate');
// Need to reload page, or it will be pending.
context.applyUpdate().then(()=>{
window.location.reload();
});
}, 1000);
},
});
};
```
## todos
1. unpkg/jsdelivr cdn zero cache?(not ok)
2. auto update interval(ok)
## license
Code released under [the MIT license](https://github.com/afeiship/sw-runtime/blob/master/LICENSE.txt).
[version-image]: https://img.shields.io/npm/v/@jswork/sw-runtime
[version-url]: https://npmjs.org/package/@jswork/sw-runtime
[license-image]: https://img.shields.io/npm/l/@jswork/sw-runtime
[license-url]: https://github.com/afeiship/sw-runtime/blob/master/LICENSE.txt
[size-image]: https://img.shields.io/bundlephobia/minzip/@jswork/sw-runtime
[size-url]: https://github.com/afeiship/sw-runtime/blob/master/dist/index.min.js
[download-image]: https://img.shields.io/npm/dm/@jswork/sw-runtime
[download-url]: https://www.npmjs.com/package/@jswork/sw-runtime