just now12 seconds ago2 hours ago3 days ago3 weeks ago2 years agoin 12 secondsin 3 minutesin 24 daysin 6 months
Usage
install
npm install timeago.js
import
import { format, render, cancel, register } from 'timeago.js';
or import with script tag in html file and access global variable timeago.
<script src="dist/timeago.min.js"></script>
example
// format the time with localeformat('2016-06-12', 'en_US');
CDN
Alternatively to NPM, you can also use a CDN which will reflect the latest version as soon as it is published to npm.
<script src="//unpkg.com/timeago.js"></script>
API
There only 4 API below.
format
format(date[, locale = 'en_US', opts]), format a Date instance / timestamp / date string to string.
import { format } from 'timeago.js';// format timestampformat(1544666010224);// format date instanceformat(new Date(1544666010224));// format date stringformat('2018-12-12');// format with localeformat(1544666010224, 'zh_CN');// format with locale and relative dateformat(1544666010224, 'zh_CN', { relativeDate: '2018-11-11' });// e.g.format(Date.now() - 11 * 1000 * 60 *
The default locale is en_US, and the library contains en_US and zh_CN build-in.
import { render, cancel } from 'timeago.js';const nodes = document.querySelectorAll('.timeago');// use render method to render nodes in real timerender(nodes, 'zh_CN');// render with opts// render(nodes, 'en_US', { minInterval: 3 });// cancel all real-time render taskcancel();// or cancel for the specific onecancel(nodes[0])
The 3rd parameter opts contains:
export type Opts = { /** the relative date */ readonly relativeDate?: TDate; /** the realtime min update interval */ readonly minInterval?: number;};
The DOM object should have the attribute datetime with date formatted string.
register
register(locale, localeFunc), register a new locale, build-in locale contains: en_US, zh_CN, all locales here.
You can register your own language with register API.
const localeFunc = (number: number, index: number, totalSec: number): [string, string] => { // number: the timeago / timein number; // index: the index of array below; // totalSec: total seconds between date to be formatted and today's date; return [ ['just now', 'right now'], ['%s seconds ago', 'in %s seconds'], ['1 minute ago', 'in 1 minute'], ['%s minutes ago', 'in %s minutes'], ['1 hour ago', 'in 1 hour'], ['%s hours ago', 'in %s hours'],
Contributions
The website is based on rmm5t/jquery-timeago which is a nice and featured project but it depends on jQuery.
locale translations: The library needs more locale translations. You can:
Open an issue to write the locale translations, or submit a pull request. How to ? see locales translation.
Please test the locale by exec npm test. How to write test cases, see locales test cases.