Relative Time1.0.0+

  1. // From 2.12.0 onward
  2. moment.updateLocale('en', {
  3.     relativeTime : Object
  4. });
  5. // From 2.8.1 to 2.11.2
  6. moment.locale('en', {
  7.     relativeTime : Object
  8. });
  10. // Deprecated in 2.8.1
  11. moment.lang('en', {
  12.     relativeTime : Object
  13. });

Locale#relativeTime should be an object of the replacement strings for moment#from.

  1. moment.updateLocale('en', {
  2.     relativeTime : {
  3.         future: "in %s",
  4.         past:   "%s ago",
  5.         s  : 'a few seconds',
  6.         ss : '%d seconds',
  7.         m:  "a minute",
  8.         mm: "%d minutes",
  9.         h:  "an hour",
  10.         hh: "%d hours",
  11.         d:  "a day",
  12.         dd: "%d days",
  13.         M:  "a month",
  14.         MM: "%d months",
  15.         y:  "a year",
  16.         yy: "%d years"
  17.     }
  18. });

Locale#relativeTime.future refers to the prefix/suffix for future dates, and Locale#relativeTime.past refers to the prefix/suffix for past dates. For all others, a single character refers to the singular, and a double character refers to the plural.

If a locale requires additional processing for a token, it can set the token as a function with the following signature.The function should return a string.

  1. function (number, withoutSuffix, key, isFuture) {
  2.     return string;
  3. }

The key argument refers to the replacement key in the Locale#relativeTime object. (eg. s m mm h, etc.)

The number argument refers to the number of units for that key. For m, the number is the number of minutes, etc.

The withoutSuffix argument will be true if the token will be displayed without a suffix, and false if it will be displayed with a suffix. (The reason for the inverted logic is because the default behavior is to display with the suffix.)

The isFuture argument will be true if it is going to use the future suffix/prefix and false if it is going to use the past prefix/suffix.