Skip to content

Commit 2a14b95

Browse files
committed
better opts repres. --README 📋 ..
1 parent 1c539dd commit 2a14b95

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

‎README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -47,16 +47,16 @@ locales(app, options);
4747

4848
Patch locales functions to koa app.
4949

50-
- {Application} app: koa app instance.
51-
- {Object} options: optional params.
52-
- {String} functionName: locale function name patch on koa context. Optional, default is `__`.
53-
- {String} dirs: locales resources store directories. Optional, default is `['$PWD/locales']`.
54-
- {String} defaultLocale: default locale. Optional, default is `en-US`.
55-
- {String} queryField: locale field name on query. Optional, default is `locale`.
56-
- {String} cookieField: locale field name on cookie. Optional, default is `locale`.
57-
- {String} cookieDomain: domain on cookie. Optional, default is `''`.
58-
- {Object} localeAlias: locale value map. Optional, default is `{}`.
59-
- {String|Number} cookieMaxAge: set locale cookie value max age. Optional, default is `1y`, expired after one year.
50+
- {Application} **app**: koa app instance.
51+
- {Object} **options**: optional params.
52+
- {String} **functionName**: locale function name patch on koa context. Optional, default is `__`.
53+
- {String} **dirs**: locales resources store directories. Optional, default is `['$PWD/locales']`.
54+
- {String} **defaultLocale**: default locale. Optional, default is `en-US`.
55+
- {String} **queryField**: locale field name on query. Optional, default is `locale`.
56+
- {String} **cookieField**: locale field name on cookie. Optional, default is `locale`.
57+
- {String} **cookieDomain**: domain on cookie. Optional, default is `''`.
58+
- {Object} **localeAlias**: locale value map. Optional, default is `{}`.
59+
- {String|Number} **cookieMaxAge**: set locale cookie value max age. Optional, default is `1y`, expired after one year.
6060

6161
```js
6262
locales({

0 commit comments

Comments
 (0)