koa-locales

koa locales, i18n solution for koa:

1. All locales resources location on options.dir.
2. One api: __(key[, value, ...])
3. Auto detect request locale from query, cookie and header: Accept-Language

Installation

$ npm install koa-locales --save

Quick start

var koa = require('koa');
var locales = require('koa-locales');

var app = koa();
app.use(locales({
  dir: __dirname + '/locales'
}));

API Reference

locales(app, options)

Patch locales functions to koa app.

• {Application} app: koa app instance.
• {Object} options: optional params
  • {String} functionName: locale function name patch on koa context. Optional, default is __.
  • {String} dir: locales resources store directory. Optional, default is $PWD/locales.
  • {String} defaultLocale: default locale. Optional, default is en-US.
  • {String} queryField: locale field name on query. Optional, default is locale.
  • {String} cookieField: locale field name on cookie. Optional, default is locale.
  • {String|Number} cookieMaxAge: set locale cookie value max age. Optional, default is 1y, expired after one year.

locales({
  app: app,
  dir: __dirname + '/app/locales',
  defaultLocale: 'zh-CN'
}));

context.__(key[, value1[, value2, ...]])

Get current request locale text.

function* home() {
  this.body = {
    message: this.__('Hello, %s', 'fengmk2')
  };
}

Examples:

__('Hello, %s. %s', 'fengmk2', 'koa rock!')
=>
'Hello fengmk2. koa rock!'

__('{0} {0} {1} {1} {1}', ['foo', 'bar'])
=>
'foo foo bar bar bar'

Usage on template

this.locales.__ = this.__.bind(this);

nunjucks example:

{{ __('Hello, %s', user.name) }}

License

MIT