README.md

moment-format

Help you to format your time tree.中文说明

Installation

$ npm install moment-format

test

$ sudo npm install -g mocha
  && npm test

API

var format = require('moment-format');
var result = format(time, limitData, language);

params

time: The time you wanna format,it can be STRING or DATE.

limitData: Your standard to format the time. It shold be json data like:

  {
    above: STING,
    limit: STING,
    unit: STING,
    leftString: STING,
    rightString: STING
  }

above: above the time distance

limit: under the time distance

unit: time unit you want to get

Input	Example	Description
null	null	When it is null, the result will just be your leftString and rightString
second	1...	seconds from now
minute	1...	minutes from now
hour	1...	hours from now
date	1...	dates from now
week	1...	weeks from now
YYYY	2014	4 or 2 digit year
YY	14	2 digit year
Q	1..4	Quarter of year. Sets month to first month in quarter.
M MM	1..12	Month number
MMM MMMM	Jan..December	Month name in locale set by moment.locale()
D DD	1..31	Day of month
Do	1st..31st	Day of month with ordinal
DDD DDDD	1..365	Day of year
X	1410715640.579	Unix timestamp
x	1410715640579	Unix ms timestamp

leftString: combine the string with result from left

rightString: combine the string with result from right

language: The time language you wanna get.

Template

If you wanna to use template of 'weibo' or 'wechat', you can see below.

var format = require('moment-format');
var yourResult  = format(yourTime, 'weibo');

or

var yourResult  = format(yourTime, 'weiboMobile');

or

var yourResult  = format(yourTime, 'wechat');

Example

var format = require('moment-format');
var limitData = [{
  limit: '60',
  unit: 'second',
  rightString: '秒之前'
  },
  {
    above: '60',
    limit: '3600',
    unit: 'minute',
    rightString: '分钟之前'
  },
  {
      above: '3600',
      limit: '36000',
      unit: 'hour',
      rightString: '小时之前'
  },
  {
    above: '36000',
    limit: '50000',
    unit: 'HH:mm',
    leftString: '今天'
  },
  {
    above: '50000',
    limit: '86400',
    unit: 'HH:mm',
    leftString: '昨天'
  },
  {
    above: '86400',
    unit: 'MMM Do'
  }
];
format(yourTime, limitData, 'zh-cn');

TODO

...

MIT Licensed