# globalize-express

> The globalize middleware for the express framework

Latest version **1.4.0** (published 2016-05-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install globalize-express
pnpm add globalize-express
yarn add globalize-express
bun add globalize-express
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.0 |
| Published | 2016-05-08 |
| First published | 2015-03-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Devang Negandhi |
| Maintainers | devangnegandhi |
| Keywords | globalize, express, localization, internationalization, globalization, transalation, i18n, l10n, g11n |

## Links

- npm: https://www.npmjs.com/package/globalize-express
- Repository: https://github.com/devangnegandhi/globalize-express
- Issues: https://github.com/devangnegandhi/globalize-express/issues
- npm.io page: https://npm.io/package/globalize-express

## Dependencies (4)

- [kew](https://npm.io/package/kew.md) ^0.7.0
- [cldrjs](https://npm.io/package/cldrjs.md) ^0.4.5
- [cldr-data](https://npm.io/package/cldr-data.md) ^29.0.0
- [globalize](https://npm.io/package/globalize.md) ^1.1.0

## Alternatives

- [messageformat](https://npm.io/package/messageformat.md) — 329.7K weekly downloads
- [@mintlify/scraping](https://npm.io/package/@mintlify/scraping.md) — 294.8K weekly downloads
- [@mintlify/previewing](https://npm.io/package/@mintlify/previewing.md) — 209.5K weekly downloads
- [@mintlify/prebuild](https://npm.io/package/@mintlify/prebuild.md) — 209.5K weekly downloads
- [@mintlify/link-rot](https://npm.io/package/@mintlify/link-rot.md) — 206.3K weekly downloads

## Recent versions

- 1.4.0 (latest) — 2016-05-08
- 1.3.0 — 2015-11-10
- 1.2.0 — 2015-09-18
- 1.1.5 — 2015-07-20
- 1.1.2 — 2015-05-29
- 1.1.1 — 2015-04-25
- 1.1.0 — 2015-04-12
- 1.0.1 — 2015-03-23
- 1.0.0 — 2015-03-20

## README

[![Build Status](https://img.shields.io/codeship/ac9f04d0-b318-0132-f2c3-7e1d8cf367b9/master.svg)](https://codeship.com/projects/70145)
[![Coverage Status](https://coveralls.io/repos/devangnegandhi/globalize-express/badge.svg?branch=master)](https://coveralls.io/r/devangnegandhi/globalize-express?branch=master)
[![Dependency Status](https://david-dm.org/devangnegandhi/globalize-express.svg)](https://david-dm.org/devangnegandhi/globalize-express)
[![devDependency Status](https://david-dm.org/devangnegandhi/globalize-express/dev-status.svg)](https://david-dm.org/devangnegandhi/globalize-express#info=devDependencies)
[![MIT License] (https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/devangnegandhi/globalize-express/blob/master/LICENSE)

# globalize-express
The [globalize](https://github.com/jquery/globalize) middleware for the express framework

## Install

    npm install globalize-express

## Load

```javascript
// load modules
var express = require('express'),
    globalizeExpress = require("globalize-express");

```

##Using with Express.js

### Use as a middleware

```javascript
// Add as a middleware to your express app
var app = express();
app.use(globalizeExpress(config));

```

### List of configuration options

```javascript
var config = {
    // list of supported locales
    locales:['en', 'ja'],

    // locale chosen if the requested locales was not found in the 'locales' array
    defaultLocale: 'en',

    // A custom cookie name which may contain the locale to use
    cookieName: null,

    // location of all the locale json files on disk
    messages: __dirname + '/locales',

    // An OPTIONAL array of cldr data to load into globalize
    // Checkout: https://github.com/jquery/globalize#2-cldr-content
    // If this property is not provided, globalize-express will dynamically load
    // all possible cldr-data for the locales listed above.
    localeData: [
    ],

    // Set this to true if running in development mode. This will delete cache before every access for localized string
    devMode: false
};
```

### Inside Your Express View
The middleware adds a `Globalize` object to the `request` object of your app. You can use this as shown here:

```javascript
module.exports = {
    index: function(req, res) {
        res.render("index", {
            title: req.Globalize.formatMessage("My Site Title"),
            desc: req.Globalize.formatMessage("My Site Description")
        });
    }
};
```

For more info on the API for Globalize, checkout [jquery/Globalize](https://github.com/jquery/globalize)

#### What locale does the `Globalize` object use?
For every individual request that your express app receives, the `Globalize` object selects the locale in the following manner (and priority):

1. It looks for a `lang` query parameter in the URL (For example: `http://yoursite.com?lang=ja` would force the gloablize-express middleware to use japanese locale)
2. It then looks for a  cookie with the name `lang` in the browser cookie that was sent back (if you have configured cookies)
3. Finally, it auto-detects the client browser locale based on the `accept-language` header property.

Depending on what was found first, it uses that as its locale to return appropriate strings.

**NOTE**: if the locale selected was not in the `config.locales` array, then it will fall back to the `config.defaultLocale` locale

## Example
There is a working express.js example app provided in this repo. Please go through the [example/README.md](https://github.com/devangnegandhi/globalize-express/tree/master/example) file to see instructions on how to run the example.

---
_Source: https://npm.io/package/globalize-express · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
