website-auto-updater

Auto update your website in client when using SPA

English · 简体中文

Installation

$ npm install website-auto-updater

or

$ pnpm add website-auto-updater

Usage

website-auto-updater exposes a class. Simply using in your SPA entry file:

import WebsiteAutoUpdater from "website-auto-updater";

const websiteAutoUpdater = new WebsiteAutoUpdater();

websiteAutoUpdater.run(() => {
  const result = window.confirm(
    "The website has been updated, do you want to refresh the page?"
  );
  if (result) {
    location.replace(websiteAutoUpdater.getHomeUrl(true));
  }
});

If you want the page to be automatically updated the first time it loads:

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(
        "The website has been updated, do you want to refresh the page?"
      );
      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.