Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smhg/express-locale
Express middleware to determine locale
https://github.com/smhg/express-locale
express express-middleware i18n internationalization l10n locale localization
Last synced: about 1 month ago
JSON representation
Express middleware to determine locale
- Host: GitHub
- URL: https://github.com/smhg/express-locale
- Owner: smhg
- License: mit
- Created: 2013-03-11T12:51:20.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2023-11-23T10:05:40.000Z (about 1 year ago)
- Last Synced: 2024-11-05T05:39:29.851Z (about 2 months ago)
- Topics: express, express-middleware, i18n, internationalization, l10n, locale, localization
- Language: JavaScript
- Homepage:
- Size: 101 KB
- Stars: 23
- Watchers: 3
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
express-locale [](https://github.com/smhg/express-locale/actions/workflows/ci.yml)
==============
Express middleware to determine the [locale identifier](https://en.wikipedia.org/wiki/Locale_(computer_software)) of the incomming request.
It returns (only) full locale identifiers based on the middleware's configuration. Configuration defines possible sources, their order and, optionally, a whitelist. For performance reasons, on each request, remaining lookups are ignored as soon as a match is found.
> Use version 1.x for Express 3 support and/or older Node versions.
## Installation
`npm install --save express-locale`
## Usage
```javascript
import express from 'express';
import createLocaleMiddleware from 'express-locale';
express()
.use(createLocaleMiddleware())
.use((req, res) => {
res.end(`Request locale: ${req.locale}`);
})
.listen(3000);
```
The `locale` property on the request object will contain an object with these properties:
```json
{
"source": "default",
"language": "en",
"region": "GB"
}
```
When using this object in a string context, its `toString` method returns the locale identifier (`en-GB` in the example above).
**Note:** only full locales (language-REGION) are returned, but a [mapping](#map) of languages to a default locale can be provided as a lookup.
## Configuration
You can pass a configuration object to `createLocaleMiddleware()` with the default being:
```json
{
"priority": ["accept-language", "default"],
"default": "en-GB"
}
```
This tells the middleware to use 2 sources in order: `accept-language`, which has no configuration, and `default` which is set to `en-GB`.
The name of the lookup used in the priority list always matches the configuration key.
### Options
* `priority` Array, default: `['accept-language', 'default']`
Defines the order of lookups. The first lookup to return a full locale will be the final result.
Built-in lookups:
* `cookie`
* `query`
* `hostname`
* `accept-language`
* `map`
* `default`
Read below on how to add custom lookups.
* `allowed` Array
If provided, each lookup's results are validated against this whitelist.
> **Note:** since this validation happens after each lookup, values which will still pass through the next lookup (like when using `map`) need to also be whitelisted as in the example below. This will likely be addressed in a future version (see [#20](https://github.com/smhg/express-locale/issues/20)).
```javascript
// example
createLocaleMiddleware({
priority: ['accept-language', 'cookie', 'map'],
map: {
'en': 'en-US',
'fr': 'fr-CA'
},
allowed: ['en', 'fr', 'en-US', 'fr-CA']
});
```
* `requestProperty` String, default `'locale'`
The property on the request object (`req`) in which the locale is set.
* `cookie` Object, default `'{name: 'locale'}'`
The `name` of the cookie that contains the locale for the cookie lookup.
Use with [cookie-parser](https://github.com/expressjs/cookie-parser) middleware.
* `query` Object, default `'{name: 'locale'}'`
The `name` of the query string parameter that contains the locale for the query lookup.
* `hostname` Object
A mapping of hostnames to locales for the hostname lookup.
```javascript
// example
createLocaleMiddleware({
priority: ['hostname'],
map: {
'en.wikipedia.org': 'en-US',
'nl.wikipedia.org': 'nl-NL'
}
});
```
* `map` Object
Maps lookup results that return only a language to a full locale.
```javascript
// example
createLocaleMiddleware({
priority: ['accept-language', 'cookie', 'map'],
map: {
'en': 'en-US',
'fr': 'fr-CA'
}
});
```
* `default` String, default `'en-GB'`
The default locale for the default lookup.
* `lookups` Object
Add custom lookups or overwrite the default ones by using the `lookups` property.
```javascript
// example
createLocaleMiddleware({
priority: ['custom'],
lookups: {
custom: (req) => req.ip === '127.0.0.1' ? 'en-US' : undefined
}
});
```