1Introduction
- description:倒计时器类
- author:ydr.me
- create:2016年11月19日11:50:03
- update:2016年11月19日11:50:03
- github:https://github.com/blearjs/blear.classes.count-down
2Example
var CountDown = require('blear.classes.count-down');
var cd = new CountDown();
cd.on('change', function(remainTime, elapsedTime) {
// ...
});
cd.start();
3.defaults
3.1.defaults.interval
- 类型:
Number
- 说明:倒计时时间间隔,单位 ms
- 默认:
1000
3.2.defaults.count
- 类型:
Number
- 说明:倒计时时间总数,单位 ms
- 默认:
60000
4Prototype
原型属性、方法
4.1#start(): cd
开始计时。
cd.start();
4.1.1cd
- 类型:
CountDown
- 说明:支持链式调用
4.2#getElapsedTime(): elapsedTime
获取流逝的时间。
cd.getElapsedTime();
4.3#getRemainTime(): remainTime
获取剩余时间。
cd.getRemainTime();
4.4#pause(): cd
暂停计时。
cd.pause();
4.4.1cd
- 类型:
CountDown
- 说明:支持链式调用
4.5#resume(): cd
恢复计时,从上一次暂停开始恢复。
cd.resume();
4.5.1cd
- 类型:
CountDown
- 说明:支持链式调用
4.6#stop(): cd
停止计时。
cd.stop();
4.6.1cd
- 类型:
CountDown
- 说明:支持链式调用
4.7#setCount(count): cd
设置倒计时总数。
cd.setCount(100000);
4.7.1count
- 类型:
Number
- 说明:倒计时总数
4.7.2cd
- 类型:
CountDown
- 说明:支持链式调用
4.8#reset(): cd
重置倒计时。
cd.start();
4.8.1cd
- 类型:
CountDown
- 说明:支持链式调用
4.9#is(): inCD
4.9.1inCD
- 类型:
Boolean
- 说明:是否在倒计时中
4.10#destroy(): undefined
停止计时,销毁计时器。
5Events
5.1start()
倒计时开始的时候触发。
5.2change(remainTime, elapsedTime)
倒计时计时变化的时候触发。
remainTime + elapsedTime === count
5.2.1remainTime
- 类型:
Number
- 说明:倒计时剩余时间
5.2.2elapsedTime
- 类型:
Number
- 说明:倒计时流逝时间
5.3stop()
倒计时结束的时候触发