# Ticker

**Repository Path**: yilishabuBai/Ticker

## Basic Information

- **Project Name**: Ticker
- **Description**: 用于维护项目时间线的工具
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-04-12
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Ticker

用于维护项目时间线的工具

## 使用示例

```js
<script type="text/javascript" src="./lib/ticker.min.js"></script>
<script>
    // 使用Ticker
</script>
```

启动

```js
Ticker.start(); // 启动Ticker，此时systemTime为0
```

或者

```js
var currentTime = new Date().getTime();
Ticker.start(currentTime);  // 启动Ticker，此时systemTime从currentTime开始计时
```

注册钩子函数

```js
// Ticker会每隔33毫秒执行一次钩子函数，并将两次执行的间隔时间当作参数传入
// 由于使用链式setTimeout调用，实际执行间隔会大于33毫秒
function callback (delayTime) {
    console.log(delayTime);
}

Ticker.register(callback);
```

注册延时执行函数

```js
function callback () {
    console.log('1000毫秒后，我会打印');
}

Ticker.registerDelay(callback, 1000);
```

注册定时执行函数

```js
function callback () {
    console.log('当systemTime到1000毫秒的时候，我会打印');
}

Ticker.registerTimer(callback, 1000);
```

## 目录说明

* ./src/ts TypeScript源码
* ./src/js JavaScript源码
* ./lib 发布出的ticker包

## 脚本命令说明

**安装依赖模块**

~~~
npm install
~~~

### package.json中已有script说明如下

**本地服务器**

~~~
npm run server
~~~

可访问http://loacalhost:8000/

**编译**

~~~
npm run build
~~~

该脚本会打包项目，生成文件在./lib中

~~~
./lib/ticker.min.js Ticker库，可直接加载后使用
~~~