Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master
Fetching contributors…

Cannot retrieve contributors at this time

57 lines (37 sloc) 1.026 kb

relative-date

Relative dates in words

Installation

$ component install component/relative-date

Example

var date = new Date(Date.now() - 60000);
console.log(relative(date) + ' ago');
// => "one minute ago"

var date = new Date(Date.now() + 5 * 60000);
console.log(relative(date) + ' from now');
// => "5 minutes from now"

API

relative(date)

Return the date in words relative to Date.now():

var relative = require('relative-date');
var date = new Date(Date.now() + 2000);

var str = relative(date) + ' ago';
// => "2 seconds ago"

An empty string "" is returned when the difference is below one second. You may use this to default the string as shown here:

var str = relative(new Date) || 'just now';
// => "just now"

var str = relative(new Date);
if (str) str = 'assignment due in ' + str;
else str = 'assignment due';
// => "assignment due"

relative(date, other)

Same as above, relative to other instead of Date.now().

License

MIT

Jump to Line
Something went wrong with that request. Please try again.