intl-relativeformat

What is intl-relativeformat?

The intl-relativeformat npm package is used for formatting relative dates and times in a human-readable way. It leverages the Internationalization API to provide locale-aware formatting, making it easier to display dates and times relative to the current date and time.

What are intl-relativeformat's main functionalities?

Basic Relative Time Formatting

This feature allows you to format a date relative to the current time. In this example, it formats a date that is one hour ago.

const IntlRelativeFormat = require('intl-relativeformat');
const rf = new IntlRelativeFormat('en');
console.log(rf.format(Date.now() - 1000 * 60 * 60)); // 'an hour ago'

Locale-Specific Formatting

This feature allows you to format dates relative to the current time in a locale-specific manner. In this example, it formats a date that is one hour ago in French.

const IntlRelativeFormat = require('intl-relativeformat');
const rf = new IntlRelativeFormat('fr');
console.log(rf.format(Date.now() - 1000 * 60 * 60)); // 'il y a une heure'

Future Date Formatting

This feature allows you to format future dates relative to the current time. In this example, it formats a date that is one hour in the future.

const IntlRelativeFormat = require('intl-relativeformat');
const rf = new IntlRelativeFormat('en');
console.log(rf.format(Date.now() + 1000 * 60 * 60)); // 'in an hour'

Other packages similar to intl-relativeformat

moment

Moment.js is a widely-used library for parsing, validating, manipulating, and formatting dates. It provides relative time formatting through its `fromNow` and `toNow` methods. Compared to intl-relativeformat, Moment.js offers a broader range of date manipulation features but is larger in size.

date-fns

date-fns is a modern JavaScript date utility library that provides a variety of functions for working with dates, including relative time formatting through its `formatDistance` and `formatDistanceToNow` functions. It is modular and tree-shakeable, making it a lightweight alternative to Moment.js.

luxon

Luxon is a modern JavaScript library for working with dates and times, created by one of the Moment.js developers. It provides relative time formatting through its `toRelative` and `toRelativeCalendar` methods. Luxon is built on top of the native JavaScript Internationalization API, similar to intl-relativeformat, but offers a more comprehensive set of features.

README

Intl RelativeFormat

Formats JavaScript dates to relative time strings (e.g., "3 hours ago").

Overview

Goals

This package aims to provide a way to format different variations of relative time. You can use this package in the browser and on the server via Node.js.

This implementation is very similar to moment.js, in concept, although it provides only formatting features based on the Unicode CLDR locale data, an industry standard that supports more than 150 locales.

Note: This IntlRelativeFormat API may change to stay in sync with ECMA-402, but this package will follow semver.

How It Works

This API is very similar to ECMA 402's DateTimeFormat and NumberFormat.

IntlRelativeFormat Constructor

To format a date to relative time, use the IntlRelativeFormat constructor. The constructor takes two parameters:

• locales - {String | String[]} - A string with a BCP 47 language tag, or an array of such strings. If you do not provide a locale, the default locale will be used, but you should always provide one!

• options - {Object} - Optional object with user defined options for format styles.

Here is the most basic example:

var rf = new IntlRelativeFormat('en');
var output = rf.format(dateValue);

The format method (which takes a JavaScript date or timestamp) will compares it with now, and returns the formatted string; e.g., "3 hours ago" in the corresponding locale passed into the constructor.

Note: The rf instance should be enough for your entire application, unless you want to use custom options.

Custom Options

The optional second argument options provides a way to customize how the relative time will be formatted.

Units

By default, the relative time is computed to the best fit unit, but you can explicitly call it to force units to be displayed in "second", "minute", "hour", "day", "month" or "year":

var rf = new IntlRelativeFormat('en', {
    units: 'day'
});
var output = rf.format(dateValue);

As a result, the output will be "70 days ago" instead of "2 months ago".

Style

By default, the relative time is computed as "best fit", which means that instead of "1 day ago", it will display "yesterday", or "in 1 year" will be "next year", etc. But you can force to always use the "numeric" alternative:

var rf = new IntlRelativeFormat('en', {
    style: 'numeric'
});
var output = rf.format(dateValue);

As a result, the output will be "1 day ago" instead of "yesterday".

Usage

Loading IntlRelativeFormat in Node.js

Install package and polyfill:

npm install intl-relativetime --save
npm install intl --save

Simply require() this package:

if (!global.Intl) {
    global.Intl = require('intl'); // polyfill for `Intl`
}
var IntlRelativeFormat = require('intl-relativeformat');
var rf = new IntlRelativeFormat('en');
var output = rf.format(dateValue);

Note: in Node.js, the data for all 150+ locales is loaded along with the library.

Loading IntlRelativeFormat in a browser

Install using bower: bower install intl-relativetime or download from dist/ folder

Include the library in your page:

<script src="intl-relativeformat/intl-relativeformat.min.js"></script>

By default, Intl RelativeFormat ships with the locale data for English built-in to the runtime library. When you need to format data in another locale, include its data; e.g., for French:

<script src="intl-relativeformat/locale-data/fr.js"></script>

Note: All 150+ locales supported by this package use their root BCP 47 langage tag; i.e., the part before the first hyphen (if any).

Intl Dependency

This package assumes that the Intl global object exists in the runtime. Intl is present in all modern browsers except Safari, and there's work happening to integrate Intl into Node.js.

Luckly, there's the Intl.js polyfill! You will need to conditionally load the polyfill if you want to support runtimes which Intl is not already built-in.

If the browser does not already have the Intl APIs built-in, the Intl.js Polyfill will need to be loaded on the page along with the locale data for any locales that need to be supported:

<script src="intl/Intl.min.js"></script>
<script src="intl/locale-data/jsonp/en-US.js"></script>

Note: Modern browsers already have the Intl APIs built-in, so you can load the Intl.js Polyfill conditionally, by for checking for window.Intl.

License

This software is free to use under the Yahoo! Inc. BSD license. See the LICENSE file for license text and copyright information.