# Time
# Members
# MS_PER_SECOND
常量：每秒钟的毫秒数
Kind: global variable
# MS_PER_MINUTE
常量：每分钟的毫秒数
Kind: global variable
# MS_PER_HOUR
常量：每小时的毫秒数
Kind: global variable
# MS_PER_DAY
常量：每天的毫秒数
Kind: global variable
# MS_PER_WEEK
常量：每周的毫秒数
Kind: global variable
/**
* 常量：每秒钟的毫秒数
*/
export const MS_PER_SECOND = 1000;
/**
* 常量：每分钟的毫秒数
*/
export const MS_PER_MINUTE = 60000;
/**
* 常量：每小时的毫秒数
*/
export const MS_PER_HOUR = 3600000;
/**
* 常量：每天的毫秒数
*/
export const MS_PER_DAY = 86400000;
/**
* 常量：每周的毫秒数
*/
export const MS_PER_WEEK = 86400 * 7;
# Classes
-
时间段，代表两个时间点之间的时长。
-
时间区间，时间区间是由两个时间点构成的一段时间。 时间区间（TimeSpan）与时间段（Duration）的区别是 时间区间具有方向性（begin --> end），时间段没有方向性。
# Duration
时间段，代表两个时间点之间的时长。
Kind: global class
# new Duration(duration)
构造器
| Param | Type | Description |
|---|---|---|
| duration | number | 时长的毫秒数 |
# duration.value
获取毫秒数
Kind: instance property of Duration
# duration.accurateMilliseconds
获取精确的毫秒数，如：500.0毫秒。
Kind: instance property of Duration
# duration.accurateSeconds
获取精确的秒数，如：0.56秒。
Kind: instance property of Duration
# duration.accurateMinutes
获取精确的分钟数，如：0.54分钟。
Kind: instance property of Duration
# duration.accurateHours
获取精确的小时数，如：0.547小时.
Kind: instance property of Duration
# duration.accurateDays
获取精确的天数，如：0.32天。
Kind: instance property of Duration
# duration.accurateMonths
获取精确的月数（每月假设都是30天），如：0.6个月。
Kind: instance property of Duration
# duration.accurateYears
获取精确的年数（每年假设是365.25天），如：1.7年。
Kind: instance property of Duration
# duration.milliseconds
获取毫秒数，省略精确值的小数部分。
Kind: instance property of Duration
# duration.seconds
获取秒数，省略精确值的小数部分。
Kind: instance property of Duration
# duration.minutes
获取分钟数，省略精确值的小数部分。
Kind: instance property of Duration
# duration.hours
获取小时数，省略精确值的小数部分。
Kind: instance property of Duration
# duration.days
获取天数，省略精确值的小数部分。
Kind: instance property of Duration
# duration.months
获取月数，省略精确值的小数部分。
Kind: instance property of Duration
# duration.years
获取年数，省略精确值的小数部分。
Kind: instance property of Duration
# TimeSpan
时间区间，时间区间是由两个时间点构成的一段时间。 时间区间（TimeSpan）与时间段（Duration）的区别是 时间区间具有方向性（begin --> end），时间段没有方向性。
Kind: global class
# new TimeSpan(begin, end)
构造器
| Param | Type | Description |
|---|---|---|
| begin | number | 开始的时间戳 |
| end | number | 结束时间戳 |
# timeSpan.begin
获取开始时间戳
Kind: instance property of TimeSpan
# timeSpan.end
获取结束时间戳
Kind: instance property of TimeSpan
# timeSpan.duration
获取时间段
Kind: instance property of TimeSpan
# timeSpan.include(timePoint) ⇒ boolean
检测此时间区间是否包含时间点timePoint。
Kind: instance method of TimeSpan Returns: boolean - timePoint是否在此时间区间内
| Param | Type | Description |
|---|---|---|
| timePoint | timePoint | 时间点 |
# timeSpan.expand() ⇒ TimePoint | TimeSpan
将此时间区间扩展到指定的时间点timePoint处。
Kind: instance method of TimeSpan Returns: TimePoint - 目标时间点TimeSpan - 扩展后的此时间区间对象
# TimePoint
时间点。表示时钟上一个特定的瞬间时间点。
Kind: global class
# new TimePoint(timestamp)
构造器
| Param | Type | Description |
|---|---|---|
| timestamp | number | 时间戳，默认为创建此对象时的时间戳。 |
# timePoint.value
获取时间戳数值
Kind: instance property of TimePoint
# timePoint.dateTime
获取日期时间结构
Kind: instance property of TimePoint
# timePoint.thisSecond
获取当前时间点所在的秒区间。
Kind: instance property of TimePoint
# timePoint.thisMinute
获取当前时间点所在的分钟区间。
Kind: instance property of TimePoint
# timePoint.thisHour
获取当前时间点所在的小时区间。
Kind: instance property of TimePoint
# timePoint.thisDay
获取当前时间点所在的日期区间。
Kind: instance property of TimePoint
# timePoint.thisWeek
获取当前时间点所在的周时间区间。
Kind: instance property of TimePoint
# timePoint.thisMonth
获取当前所在时间点的月时间区间。
Kind: instance property of TimePoint
# timePoint.thisYear
获取当前时间点所在的年时间区间。
Kind: instance property of TimePoint
# timePoint.toString()
转换成格式化字符串。格式字符串语法：
month/year => 03/2010
hour:minute:second => 08:45:59
完整语法如下：
year: 年份
month: 月份
date: 日期
hour: 小时
minute: 分钟
second: 秒
ms: 毫秒
Kind: instance method of TimePoint
# timePoint.add(duration) ⇒ TimePoint
加法，计算此时间点加上一段时间的时间点。
Kind: instance method of TimePoint Returns: TimePoint - 结果时间点
| Param | Type | Description |
|---|---|---|
| duration | Duration | 时间段 |
# timePoint.sub(duration) ⇒ TimePoint
减法，计算此时间点减去一段时间的时间点。
Kind: instance method of TimePoint Returns: TimePoint - 结果时间点
| Param | Type | Description |
|---|---|---|
| duration | Duration | 时间段 |
# timePoint.from(timePoint) ⇒ TimePoint
计算从某个特定时间点开始到当前时间点结束的的时间区间。
Kind: instance method of TimePoint Returns: TimePoint - 时间区间
| Param | Type | Description |
|---|---|---|
| timePoint | TimePoint | 开始时间点 |
# timePoint.to(timePoint) ⇒ TimePoint
计算从当前时间点开始到某个特定时间点结束的的时间区间。
Kind: instance method of TimePoint Returns: TimePoint - 时间区间
| Param | Type | Description |
|---|---|---|
| timePoint | TimePoint | 结束时间点 |
# TimePoint.now()
获取当前时刻的时间点。
Kind: static method of TimePoint
# TimePoint.utc()
获取dateTime结构所描述的UTC时间点。
Kind: static method of TimePoint
# TimePoint.parse()
解析时间字符串，相当于Date.parse()。
Kind: static method of TimePoint
# duration(ms) ⇒ Duration
创建一个时间段对象
Kind: global function Returns: Duration - 时间段对象
| Param | Type | Description |
|---|---|---|
| ms | number | 时间段的毫秒数 |
# span(beginTimeStamp, endTimeStamp) ⇒ TimeSpan
创建一个时间区间对象。
Kind: global function Returns: TimeSpan - 时间区间对象
| Param | Type | Description |
|---|---|---|
| beginTimeStamp | number | TimePoint |
| endTimeStamp | number | TimePoint |
# point(timestamp) ⇒ TimePoint
创建一个时间点对象。
Kind: global function Returns: TimePoint - 时间点对象
| Param | Type | Description |
|---|---|---|
| timestamp | number | 时间戳 |
# now()
获取现在时刻的时间点对象。
# utc()
获取dateTime结构所描述的UTC时间点。
# parse()
解析时间字符串，相当于Date.parse()。
# add(timePoint, duration) ⇒ TimePoint
计算时间点timePoint加上时间段duration的时间点。
Kind: global function Returns: TimePoint - 结果时间点对象
| Param | Type | Description |
|---|---|---|
| timePoint | TimePoint | 时间点对象 |
| duration | Duration | 时间段对象 |
# sub(timePoint, duration) ⇒ TimePoint
计算时间点timePoint减去时间段duration的时间点。
Kind: global function Returns: TimePoint - 结果时间点对象
| Param | Type | Description |
|---|---|---|
| timePoint | TimePoint | 时间点对象 |
| duration | Duration | 时间段对象 |