Skip to content

Latest commit

 

History

History
89 lines (65 loc) · 2.59 KB

README.zh-CN.md

File metadata and controls

89 lines (65 loc) · 2.59 KB
Raw

website-auto-updater

NPM version NPM downloads

在单页面(SPA)应用中自动检测网站更新

English · 简体中文

安装

$ npm install website-auto-updater

or

$ pnpm add website-auto-updater

使用

website-auto-updater 导出了一个类，可以在 SPA 入口文件中直接使用：

import WebsiteAutoUpdater from "website-auto-updater";

const websiteAutoUpdater = new WebsiteAutoUpdater();

websiteAutoUpdater.run(() => {
  const result = window.confirm("网站有更新，是否刷新页面？");
  if (result) {
    location.replace(websiteAutoUpdater.getHomeUrl(true));
  }
});

如果你想要在首次进入网站时自动检测更新，参考如下示例：

import WebsiteAutoUpdater from "website-auto-updater";

const websiteAutoUpdater = new WebsiteAutoUpdater({
  interval: 5 * 1000,
});

websiteAutoUpdater.isWebsiteNeedUpdate().then((isNeedUpdate) => {
  if (isNeedUpdate) {
    location.replace(websiteAutoUpdater.getHomeUrl(true));
  } else {
    oldRender();
    websiteAutoUpdater.run(() => {
      const result = window.confirm("网站有更新，是否刷新页面？");
      if (result) {
        location.replace(websiteAutoUpdater.getHomeUrl(true));
      }
    });
  }
});

LICENSE

MIT License

Copyright (c) 2024 听风

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.