h5-check-update/README.zh.md

H5 page checks for updates and alerts

# h5-check-update

H5 页面检查更新和提醒；实现每 5 分钟检测源站的 `index.js` 文件的哈希值的变化。两次哈希值不一样则表明需要更新。

## 安装

```shell
npm install h5-check-update
```

## Usage

使用 [Vite 的 Web Workers import](https://cn.vite.dev/guide/features.html#web-workers) 能够快速集成。只需引入文件就行。

### 使用

在主文件，例如: `main.js` 或者 `index.js` 中添加如下代码，引入即可：

```javascript
import "h5-check-update";
```

## 函数

```javascript
import { checkUpdate, destroy } from "h5-check-update";
```

### 1. `checkUpdate()`

开启更新检查；通常不需要手动调用该函数，引入文件时会自动调用。

### 2. `destroy()`

停止检查更新，关闭 `worker`，释放资源。