目錄

一.簡介
二.安裝方式
三、正計時器的使用方式
四、倒計時器的使用方式
五、計時狀態(tài)
六、接口文檔

內(nèi)容

一、簡介

clocker-js 是計時器，有 正計時 和 倒計時 的功能，并且支持計時超時；

如果您在使用該庫的過程中有遇到了問題，或者有好的建議和想法，您都可以通過以下方式聯(lián)系我，期待與您的交流：

• 郵箱：guobinyong@qq.com
• QQ：guobinyong@qq.com
• 微信：keyanzhe

二、安裝方式

目前，安裝方式有以下幾種：

方式1：通過 npm 安裝

npm install --save clocker-js

方式2：直接下載原代碼

您可直接從 本項目的Git倉庫 下載，此倉庫里包含了 clocker 和 下文的示例代碼；clocker 庫是 本項目的Git倉庫 項目中的 clocker/Clocker.js 文件，您可以直接把該文件拷貝到您的項目中去；然后使用如下代碼在您的項目中引入 Clocker：

import { Clocker } from "path/to/package/Clocker.js";

或者

import Clocker from "path/to/package/Clocker.js";

三、正計時器的使用方式

1. 創(chuàng)建 目標時間 對象:

   let targetDate = new Date();
   

2. 用目標時間對象初始化計時器實例：

   let clocker = new Clocker(targetDate);  // 創(chuàng)建 計時器對象
   

   也可以先創(chuàng)建定時器，再更改 目標時間，如下：

   let clocker = new Clocker();  // 創(chuàng)建 計時器對象
   clocker.targetDate = targetDate;  // 更改 目標時間
   

3. 在你需要的時候獲取定時器實例的相關(guān)計時信息；

   let year = clocker.year;
   let month = clocker.month;
   let date = clocker.date;
   let hours = clocker.hours;
   let minutes = clocker.minutes;
   let seconds = clocker.seconds;
   
   console.log(year,month,date,hours,minutes,seconds);
   

四、倒計時器的使用方式

1. 創(chuàng)建 目標時間 對象:

   let targetDate = new Date(2020,2,3,13,0,0);
   

2. 用目標時間對象初始化計時器實例：

   let clocker = new Clocker(targetDate,true);  // 創(chuàng)建 計時器對象
   

   也可以先創(chuàng)建定時器，再更改 目標時間，如下：

   let clocker = new Clocker();  // 創(chuàng)建 計時器對象;
   clocker.targetDate = targetDate;  // 更改 目標時間
   clocker.countDown = true;  // 設置 計時器 為倒計時器；
   

3. 在你需要的時候獲取定時器實例的相關(guān)計時信息；

   let year = clocker.year;
   let month = clocker.month;
   let date = clocker.date;
   let hours = clocker.hours;
   let minutes = clocker.minutes;
   let seconds = clocker.seconds;
   
   console.log(year,month,date,hours,minutes,seconds);
   

五、計時狀態(tài)

計時器實例有個只讀屬性 isCounting ，表示計時器的狀態(tài)；

當 isCounting 的值為 true 時，表示目前正在正常地計時；
當 isCounting 的值為 false 時，表示目處于非正在正常計時狀態(tài)，具體的含義如下：

• 在正計時中表示：還未到達開始計時時間；
• 在倒計時中表示：已經(jīng)到達結(jié)束時間；

并且，當 isCounting 的值為 false 時，實例的 year、month、date、hours、minutes、seconds、milliseconds 均是負值；

六、接口文檔

constructor

constructor(targetDate, countDown)

• @param targetDate : Date 目標時間，在正計時中，目標時間是計時的起始時間；在倒計時中，目標時間為結(jié)束時間；默認為當前時間
• @param countDown : boolean 是否是倒計時，默認為 false

isCounting

• @readonly : boolean

說明：
計時是否正在正常地進行中

注意：

• 在正計時中，返回 false 表示：還未到達開始計時時間；
• 在倒計時中，返回 false 表示：已經(jīng)到達結(jié)束時間；

dateObj

• @readonly : Date

說明：
獲得計時的 Date 對象 (以世界標準時間(UTC)計時)

year

• @readonly : number

說明：
獲得計時的年數(shù)

month

• @readonly : number

說明：
獲得計時的月數(shù)

date

• @readonly : number

說明：
獲得計時的天數(shù)

hours

@readonly : number

說明：
獲得計時的小時數(shù)

minutes

• @readonly : number

說明：
獲得計時的分鐘數(shù)

seconds

• @readonly : number

說明：
獲得計時的秒鐘數(shù)

milliseconds

• @readonly : number

說明：
獲得計時的毫秒數(shù)