i18next-express-middleware - npm Package Compare versions

Comparing version 0.0.15 to 0.0.16

lib/LanguageDetector.js

@@ -41,3 +41,3 @@ 'use strict';
   return {
-    order: [/*'path',*/'querystring', 'cookie', 'header'],
+    order: [/*'path', 'session' */'querystring', 'cookie', 'header'],
     lookupQuerystring: 'lng',
@@ -44,0 +44,0 @@ lookupCookie: 'i18next',

lib/languageLookups/cookie.js

@@ -21,6 +21,6 @@ 'use strict';
       if (req.cookies) {
-        found = req.cookies[options.cookieName];
+        found = req.cookies[options.lookupCookie];
       } else {
         var cookies = new _cookies2['default'](req, res);
-        found = cookies.get(options.cookieName);
+        found = cookies.get(options.lookupCookie);
       }
@@ -27,0 +27,0 @@ }

package.json

 {
   "name": "i18next-express-middleware",
-  "version": "0.0.15",
+  "version": "0.0.16",
   "description": "express middleware for i18next",
@@ -5,0 +5,0 @@ "main": "./lib/index.js",

README.md

@@ -1,5 +0,164 @@
-# i18next-express-middleware
+# Introduction
 
+This is a middleware to use i18next in express.js.
 
-`gulp build` builds release version
-`gulp build --debug` will build unminified version
+# Getting started
+
+Source can be loaded via [npm](https://www.npmjs.com/package/i18next-express-middleware).
+
+```
+# npm package
+$ npm install i18next-express-middleware
+```
+
+## wire up i18next to request object
+
+```js
+var i18next = require('i18next');
+var middleware = require('i18next-express-middleware');
+var express = require('express');
+
+i18next.init(i18nextOptions);
+
+var app = express();
+app.use(middleware.handle(i18next));
+
+
+// in your request handler
+app.get('myRoute', function(req, res) {
+  var lng = req.language; // 'de-CH'
+  var lngs = req.languages; // ['de-CH', 'de', 'en']
+  req.i18n.changeLanguage('en'); // will not load that!!! assert it was preloaded
+
+  var exists = req.i18n.exists('myKey');
+  var translation = req.t('myKey');
+});
+
+// in your views, eg. in jade
+div=t('myKey')
+```
+
+## add routes
+
+```js
+// missing keys
+app.post('/locales/add/:lng/:ns', middleware.missingKeyHandler(i18next));
+
+// multiload backend route
+app.get('/locales/resources.json', middleware.getResourcesHandler(i18next));
+```
+
+## language detection
+
+Detects user language from current request. Comes with support for:
+
+- path
+- cookie
+- header
+- querystring
+- session
+
+Wiring up:
+
+```js
+var i18next = require('i18next');
+var middleware = require('i18next-express-middleware');
+
+i18next
+  .use(middleware.LanguageDetector)
+  .init(i18nextOptions);
+```
+
+As with all modules you can either pass the constructor function (class) to the i18next.use or a concrete instance.
+
+## Detector Options
+
+```js
+{
+  // order and from where user language should be detected
+  order: [/*'path', 'session', */ 'querystring', 'cookie', 'header'],
+
+  // keys or params to lookup language from
+  lookupQuerystring: 'lng',
+  lookupCookie: 'i18next',
+  lookupSession: 'lng',
+  lookupFromPathIndex: 0,
+
+  // cache user language
+  caches: false, // ['cookie']
+
+  // optional expire and domain for set cookie
+  cookieExpirationDate: new Date(),
+  cookieDomain: 'myDomain'
+}
+```
+
+Options can be passed in:
+
+**preferred** - by setting options.detection in i18next.init:
+
+```js
+var i18next = require('i18next');
+var middleware = require('i18next-express-middleware');
+
+i18next
+  .use(middleware.LngDetector)
+  .init({
+    detection: options
+  });
+```
+
+on construction:
+
+```js
+var middleware = require('i18next-express-middleware');
+var lngDetector = new middleware.LngDetector(null, options);
+```
+
+via calling init:
+
+```js
+var middleware = require('i18next-express-middleware');
+
+var lngDetector = new middleware.LngDetector();
+lngDetector.init(options);
+```
+
+## Adding own detection functionality
+
+### interface
+
+```js
+module.exports {
+  name: 'myDetectorsName',
+
+  lookup: function(req, res, options) {
+    // options -> are passed in options
+    return 'en';
+  },
+
+  cacheUserLanguage: function(req, res, lng, options) {
+    // options -> are passed in options
+    // lng -> current language, will be called after init and on changeLanguage
+
+    // store it
+  }
+};
+```
+
+
+### adding it
+
+```js
+var i18next = require('i18next');
+var middleware = require('i18next-express-middleware');
+
+var lngDetector = new middleware.LngDetector();
+lngDetector.addDetector(myDetector);
+
+i18next
+  .use(lngDetector)
+  .init({
+    detection: options
+  });
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

21059

increased by17.77%

Number of lines in readme file

165

increased by2650%

No dependency changes