js-timers
TypeScript icon, indicating that this package has built-in type declarations

0.2.8 • Public • Published

js-timers

Include modules

  1. class : Timer

    Timer used in browser,More accurate than setInterval .

    Because JavaScript is a single thread, setInterval will be affected by the execution of other events in the process of running, resulting in the delay of timer, and the delay will gradually accumulate, resulting in larger timer deviation

    This module is realized through setTimeout, and the deviation is compensated and corrected

    For details, please refer to demo: https://github.com/mayuxian/js-timers/tree/main/demo

  2. class : CountDownTimer

    It can set time interval to execute countdown, which is based on timer in this library.

Installing

Using npm:

$ npm install js-timers

Using bower:

$ bower install js-timers

Using yarn:

$ yarn add js-timers

Module : Timer

// import Timer
import { Timer } from 'js-timers'

// Example
function main(){
   this._timer = new Timer(); //create instance
   this._timer.interval = 1000 // default: 1000ms
   // deault:false
   // false:When the countdown error exceeds the time interval, 
   //       will be executed immediately tick event. 
   // true:Otherwise, miss the tick event.
   this._timer.missTickEnabled = false
   this._timer.tick = () => {
       //Timer interval trigger event
   }
 }

Module : CountDownTimer

// import Timer
import { CountDownTimer } from 'js-timers'

// Example
function main(){
   this._timer = new CountDownTimer(); //create instance
   this._timer.timeoutSeconds = 60 // default: 60s
   // the mode:  default:once 
   // once:Stop when the countdown is over  倒计时结束后立刻停止
   // loop:after the timer stop,restart   倒计时结束后重新启动
   // reset:reset countdown after user operation 用户操作则倒计时重新开始
   this.timer.timeoutMode='once' 
   this._timer.missTickEnabled = false //deault:false, false:When the countdown error exceeds the time interval, false will be executed immediately. true:Otherwise, miss the tick event.
   this._timer.tick = (remainingSeconds) => {
       //remainingSeconds is remaining time
       //Timer interval trigger event
   }
 }
// vue 2.x
<template>
   <div>
      <!-- Bind the countdown. Suggest this way -->
       {{timer.remainingSeconds}}
    </div>
</template>
export default {
  data(){
   return {
      timer:{
          remainingSeconds
      }
    }
  },
  created(){
       this.timer = new CountDownTimer(); //create instance
       this.timer.timeoutSeconds = 60 // default: 60s
       this.timer.missTickEnabled = false //deault:false, false:When the countdown error exceeds the time interval, false will be executed immediately. true:Otherwise, miss the tick event.
       this.timer.tick = (remainingSeconds) => {
           //remainingSeconds is remaining time
           //Timer interval trigger event
       }
  }
}

Thx. Enjoy It !

Package Sidebar

Install

npm i js-timers

Weekly Downloads

2

Version

0.2.8

License

MIT

Unpacked Size

26.4 kB

Total Files

13

Last publish

Collaborators

  • mayuxian