Code Monkey home page Code Monkey logo

beat's Introduction

Beat.js

Never stop the beats ~

This lib will help you detect remote scripts URL change in a Polling way. Thus you can do things like remind the users to reload page, etc.

The theory is simple, that is to keep fetching the current page in text, and compare the differences of src in script tags between page loaded and the remote. When there is one or more scripts of the remote page is not included in the current page, a confirm dialog is poped up (see config to modify this default behaviour).

WARNING: To get accurate src of script tags in the remote page, createElement is used, even though the element is not insert in the document, but there may have some side effects you need to care.

usage

via NPM

npm install beatjs

or

yarn add beatjs

then

import Beat from 'beatjs';

Beat.roll();

you can call Beat.stop() to stop checking.

config

you may customize some behaviour by passing a config object in.

Beat.roll({
  // the polling interval, default to 30s
  interval: 30 * 1000,
  // default to a browser confirm dialog, when Ok is clicked, the location.reload is called.
  onChangeDetected: function (changeList) {
    // changeList is a array of script URL not in current page
    // do things you like
  },
  // the text shown in the confirm dialog mentioned above, default to below
  hintText: '检测到程序更新,请立即刷新页面',
})

beat's People

Contributors

donyell-wang avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.