Skip to content
This repository has been archived by the owner on Apr 19, 2023. It is now read-only.
/ express-intl Public archive

Internationalization middleware and helpers for Express using Format.js

License

Notifications You must be signed in to change notification settings

redbugz/express-intl

Repository files navigation

Note: This project is no longer maintained

This library provides Express middleware and helpers for internationalization. The helpers provide a declarative way to format dates, numbers, and string messages with pluralization support.

npm Version Build Status Dependency Status

Sauce Test Status

Overview

Express Intl is related to FormatJS, additional docs can be found on the website: http://formatjs.io/integrations/

Features

  • Display numbers with separators.
  • Display dates and times correctly.
  • Display dates relative to "now".
  • Pluralize labels in strings.
  • Support for 200+ languages.
  • Runs in the browser and Node.js.
  • Built on standards.

Example

See the example directory for a running example.

Register the middleware in your Express app:

var ExpressIntl = require('express-intl');
var app = require('express')();
var messages = {
"en-US": {
        "photos.summary": "{name} took {numPhotos, plural, =0 {no photos} =1 {one photo} other {# photos} } on {takenDate, date, long}."
    },
    "es-ES": {
        "photos.summary": "El {takenDate, date, long}, {name} {numPhotos, plural, =0 {no} other {} } sacó {numPhotos, plural, =0 {ninguna foto.} =1 {una foto.} other {# fotos.} }"
    },
    "ja-JP": {
        "photos.summary": "{name}は{takenDate, date, long}に{numPhotos, plural, =0 {1枚も写真を撮りませんでした。} =1 {1枚写真を撮りました。} other {#枚写真を撮りました。} }"
    },
};    
app.use(ExpressIntl.middleware());

Now in your app or template, use the res.locals.intl object to internationalize your application

Template (this example is EJS, but any template should work, see example app):

<%= intl.formatNumber(9876543.21, "currency", {currency: "USD"}) %>
<%= intl.get("photos.summary", { name:"Annie", numPhotos:1000, takenDate:Date.now() }) %>

This example would render: "$9,876,543.21" and "Annie took 1,000 photos on September 7, 2015.". The photos.summary message is written in the industry standard ICU Message syntax, which you can also learn about on the FormatJS website.

Contribute

Let's make Express Intl and FormatJS better! If you're interested in helping, all contributions are welcome and appreciated. Express Intl is just one of many packages that make up the FormatJS suite of packages, and you can contribute to any/all of them, including the Format JS website itself.

Check out the Contributing document for the details. Thanks!

License

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

About

Internationalization middleware and helpers for Express using Format.js

Resources

License

Stars

Watchers

Forks

Packages

No packages published