simonvareille
/
locales
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'feature-plural-translations' into feature-plural-fallback

feature-plural-fallback
Simon Vareille 2020-06-18 14:47:30 +02:00
parent 86598190f2 a2d4083e95
commit 68d3ae4dd4
No known key found for this signature in database
GPG Key ID: 008AE8E706CC19F9
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -11,7 +11,7 @@ koa locales, i18n solution for koa:
1. All locales resources location on `options.dirs`. 1. All locales resources location on `options.dirs`.
2. resources file supports: `*.js`, `*.json`, `*.yml`, `*.yaml` and `*.properties`, see [examples](test/locales/). 2. resources file supports: `*.js`, `*.json`, `*.yml`, `*.yaml` and `*.properties`, see [examples](test/locales/).
3. One api: `__(key[, value, ...])`. 3. Api: `__(key[, value, ...])`, `__n(key, count[, value, ...])`.
4. Auto detect request locale from `query`, `cookie` and `header: Accept-Language`. 4. Auto detect request locale from `query`, `cookie` and `header: Accept-Language`.
## Installation ## Installation
@ -42,6 +42,7 @@ Patch locales functions to koa app.
- {Application} app: koa app instance. - {Application} app: koa app instance.
- {Object} options: optional params. - {Object} options: optional params.
- {String} functionName: locale function name patch on koa context. Optional, default is `__`. - {String} functionName: locale function name patch on koa context. Optional, default is `__`.
- {String} functionnName: locale function (with plurals management) name patch on koa context. Optional, default is `__n`.
- {String} dirs: locales resources store directories. Optional, default is `['$PWD/locales']`. - {String} dirs: locales resources store directories. Optional, default is `['$PWD/locales']`.
- {String} defaultLocale: default locale. Optional, default is `en-US`. - {String} defaultLocale: default locale. Optional, default is `en-US`.
- {Boolean} fallbackToDefaultLocale: fall back to default local if current translation is not found. Optional, default is `false`. - {Boolean} fallbackToDefaultLocale: fall back to default local if current translation is not found. Optional, default is `false`.