@terky/update-notifier
v1.3.0
Published
<div align="center"> <h1>Update-notifier</h1> </div> <div align="center">
Downloads
6
Readme
update-notifier是一个用于网站更新时通知用户更新网页内容的插件，支持IE10+，它使用了web workers来发送请求
使用
update-notifier导出了一个函数useNotification，接收以下的参数
| name | required | type | default | remark |
|----------|----------|---------------------------------|---------|----------------|
| delay | true | number | 180000 | 查询间隔 |
| loop | false | boolean | false | 查询到更新后，是否继续查询 |
| init | false | string | ${window.origin}?t=${Date.now()} | 请求地址 |
| key | true | string | | 要查询的字段 |
| init | false | Fetch.init | {method: "get"} | fetch请求参数，详情 |
您可以放心，您传入的request函数也会在web worker中执行
例子
搭配webpack
您需要安装
html-webpack-plugin，下面详细说明了如何使用
module.exports = {
...
plugins: [
...,
new HtmlWebpackPlugin({
title: 'title',
hash: new Data().getTime(),
template: path.resolve(__dirname, '../index.html')
})
],
...
}在您的模版文件中
<html>
...
<body data-hash="<%= htmlWebpackPlugin.options.hash %>">
...
</body>
</html>
在您项目入口位置
import { useNotification } from '@terky/update-notifier'
...
useNotification({
key: 'data-hash'
})
...
window.addEventListener('siteUpdate', function({ detail }) {
if (detail.data) {
// do something
}
})