time-formater v1.1.3

time-formater

不是 time-formatter

English

在javascript中显示日期。

使用方法

npm i -S time-formater

const time = require('time-formater')

let rawDate = time().format('YYYY-MM-DD HH:mm:ss') // 当前时间
console.log(rawDate) // 2017-05-21 15:19:34

解析

• 当前时间

let now = time()

如果参数为空则获取当前系统时间。

• 数字

let date = time(1495355143424)

如果传入参数为数字，则表示UTC时间戳。

• 字符串

let date = time('2017-05-21')
// or
let date = time('2017-05-21 16:37:02')
// or
let date = time('2017-05-21 13:20:35+0800')
// or
let date = time('2017-05-21 19:02:59-08:00')
// or
let date = time('2017-05-21 12:38:49Z')

如果传入字符串，则必须符合ISO 8601格式。

• 原生日期对象

let date = time(new Date())

传入参数也可以是一个原生的javascript日期对象。

显示

format(string)

let rawDate = time().format('YYYY-MM-DD') // 2017-05-21

特定字符串所代表的含义

时差 （以现在为基准）

fromNow()

let fromNow = time('2017-01-01').fromNow()
console.log(fromNow) // 4个月前

倒计时

const time = require('time-formater')
let remain = 100000 // 10万秒
let countdown = time.countdown(remain)
let token = '剩余：d天H小时m分钟s秒'

// 浏览器
function step() {
    document.title = countdown.format(token) // 剩余：1天3小时46分钟40秒
    requestAnimationFrame(step)
}
step()

countdown(time)

• time \<number | string | Date> 类型为数字表示剩余的秒数，为Date实例或字符串（符合ISO 8601格式），表示结束的时间点。

返回倒计时的时间量。

format(token)

• token \<string> 用于指定输出格式。例：'剩余：d天H小时m分钟s秒' => "剩余：1天11小时4分钟38秒"。

将时间量格式化为字符串。