版本检查更新SDK
npm install fm-version-check-update一个轻量级的 Web 应用版本检查更新 SDK,自动检测应用版本变化并提示用户刷新页面。
- 🔄 自动版本检测:通过轮询机制自动检测应用版本更新
- 💾 本地存储:使用 localStorage 存储版本标识,避免重复提示
- 🎯 智能轮询:页面可见时自动检查,不可见时停止轮询以节省资源
- 🎨 优雅提示:检测到更新时显示美观的更新提示弹窗
- 📦 轻量级:体积小,无外部依赖
``bash`
npm install fm-version-check-update
`html`
`javascript
import initCheckVersion from 'fm-version-check-update'
initCheckVersion('myApp', 10000)
`
`javascript
const initCheckVersion = require('fm-version-check-update')
initCheckVersion('myApp', 10000)
`
初始化版本检查功能。
参数:
| 参数 | 类型 | 必填 | 说明 |
| ---------- | -------- | ---- | ------------------------------------------------------------------------------------- |
| key | string | 是 | 项目标识,用于在 localStorage 中存储版本标识的 key。最终存储的 key 为 {key}_Version |interval
| | number | 否 | 检查间隔(毫秒),默认值为 10000ms(10 秒)。最小值为 10000ms |
示例:
`javascript
// 基本使用(使用默认间隔 10 秒)
initCheckVersion('myApp')
// 自定义检查间隔(20秒)
initCheckVersion('myApp', 20000)
`
1. 版本标识生成:获取页面 HTML,提取所有
`
`jsx
import { useEffect } from 'react'
import initCheckVersion from 'fm-version-check-update'
function App() {
useEffect(() => {
initCheckVersion('react-app', 10000)
}, [])
return
❓ 常见问题
Q: 为什么修改代码后没有检测到版本更新?
A: 确保 webpack 配置使用了
contenthash。Q: 如何清除已保存的版本标识?
A: 在浏览器控制台执行:
localStorage.removeItem('your-project-key_Version')`Q: 检查间隔可以设置为小于 10 秒吗?
A: 不可以。为了性能考虑,最小检查间隔为 10 秒。
MIT License