@eggjs/i18n 4.0.0-beta.32 → 4.0.0-beta.34

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +16 -12
  2. package/dist/index.d.ts +17 -3
  3. package/dist/index.js +21 -4
  4. package/package.json +8 -11
package/README.md CHANGED
@@ -23,17 +23,7 @@
23
23
 
24
24
  ## 配置
25
25
 
26
- 默认处于关闭状态，你需要在 `config/plugin.ts` 开启它：
27
-
28
- ```ts
29
- // config/plugin.ts
30
- export default {
31
- i18n: {
32
- enable: true,
33
- package: '@eggjs/i18n',
34
- },
35
- };
36
- ```
26
+ egg 内置插件 `i18n` 默认开启。
37
27
 
38
28
  你可以修改 `config/config.default.ts` 来设定 i18n 的配置项：
39
29
 
@@ -42,7 +32,7 @@ export default {
42
32
  export default {
43
33
  i18n: {
44
34
  // 默认语言，默认 "en_US"
45
- defaultLocale: 'zh-CN',
35
+ defaultLocale: 'zh_CN',
46
36
  // URL 参数，默认 "locale"
47
37
  queryField: 'locale',
48
38
  // Cookie 记录的 key, 默认："locale"
@@ -116,6 +106,20 @@ export default ctx => {
116
106
  };
117
107
  ```
118
108
 
109
+ ### HttpController 下的使用示例
110
+
111
+ ```ts
112
+ import { HTTPController, HTTPMethod, HTTPMethodEnum, HTTPContext, Context } from 'egg';
113
+
114
+ @HTTPController()
115
+ export default class I18nController {
116
+ @HTTPMethod({ method: HTTPMethodEnum.GET, path: '/i18n' })
117
+ async getI18n(@HTTPContext() ctx: Context) {
118
+ return { message: ctx.__('Welcome back, %s!', ctx.user.name) };
119
+ }
120
+ }
121
+ ```
122
+
119
123
  ### View 文件下的使用示例
120
124
 
121
125
  ```html
package/dist/index.d.ts CHANGED
@@ -1,4 +1,18 @@
1
- import './config/config.default.ts';
2
- import './app/extend/context.ts';
3
- import './app/extend/application.ts';
4
1
  import './types.ts';
2
+ import { type EggPluginFactory } from 'egg';
3
+ /**
4
+ * I18n plugin
5
+ *
6
+ * @since 4.1.0
7
+ * Usage:
8
+ * ```ts
9
+ * // config/plugin.ts
10
+ * import i18nPlugin from '@eggjs/i18n';
11
+ *
12
+ * export default {
13
+ * ...i18nPlugin(),
14
+ * };
15
+ * ```
16
+ */
17
+ declare const _default: EggPluginFactory;
18
+ export default _default;
package/dist/index.js CHANGED
@@ -1,5 +1,22 @@
1
- import "./config/config.default.js";
2
- import "./app/extend/context.js";
3
- import "./app/extend/application.js";
4
1
  import "./types.js";
5
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyw0QkFBNEIsQ0FBQztBQUNwQyxPQUFPLHlCQUF5QixDQUFDO0FBQ2pDLE9BQU8sNkJBQTZCLENBQUM7QUFDckMsT0FBTyxZQUFZLENBQUMifQ==
2
+ import { definePluginFactory } from 'egg';
3
+ /**
4
+ * I18n plugin
5
+ *
6
+ * @since 4.1.0
7
+ * Usage:
8
+ * ```ts
9
+ * // config/plugin.ts
10
+ * import i18nPlugin from '@eggjs/i18n';
11
+ *
12
+ * export default {
13
+ * ...i18nPlugin(),
14
+ * };
15
+ * ```
16
+ */
17
+ export default definePluginFactory({
18
+ name: 'i18n',
19
+ enable: true,
20
+ path: import.meta.dirname,
21
+ });
22
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxZQUFZLENBQUM7QUFFcEIsT0FBTyxFQUFFLG1CQUFtQixFQUF5QixNQUFNLEtBQUssQ0FBQztBQUVqRTs7Ozs7Ozs7Ozs7OztHQWFHO0FBQ0gsZUFBZSxtQkFBbUIsQ0FBQztJQUNqQyxJQUFJLEVBQUUsTUFBTTtJQUNaLE1BQU0sRUFBRSxJQUFJO0lBQ1osSUFBSSxFQUFFLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTztDQUMxQixDQUFxQixDQUFDIn0=
package/package.json CHANGED
@@ -1,10 +1,7 @@
1
1
  {
2
2
  "name": "@eggjs/i18n",
3
- "version": "4.0.0-beta.32",
3
+ "version": "4.0.0-beta.34",
4
4
  "description": "i18n plugin for egg",
5
- "eggPlugin": {
6
- "name": "i18n"
7
- },
8
5
  "keywords": [
9
6
  "egg",
10
7
  "egg-plugin",
@@ -45,22 +42,22 @@
45
42
  "ini": "^6.0.0",
46
43
  "js-yaml": "^4.1.0",
47
44
  "utility": "^2.5.0",
48
- "@eggjs/utils": "5.0.0-beta.32"
45
+ "@eggjs/utils": "5.0.0-beta.34"
49
46
  },
50
47
  "peerDependencies": {
51
- "egg": "4.1.0-beta.32"
48
+ "egg": "4.1.0-beta.34"
52
49
  },
53
50
  "devDependencies": {
54
51
  "@types/ini": "^4.1.1",
55
52
  "@types/js-yaml": "4",
56
53
  "@types/node": "^24.9.1",
57
54
  "egg-view-nunjucks": "^2.3.0",
58
- "tsdown": "0.15.10",
55
+ "tsdown": "0.15.11",
59
56
  "typescript": "^5.9.3",
60
- "vitest": "4.0.4",
61
- "@eggjs/mock": "7.0.0-beta.32",
62
- "@eggjs/tsconfig": "3.1.0-beta.32",
63
- "egg": "4.1.0-beta.32"
57
+ "vitest": "4.0.5",
58
+ "@eggjs/tsconfig": "3.1.0-beta.34",
59
+ "egg": "4.1.0-beta.34",
60
+ "@eggjs/mock": "7.0.0-beta.34"
64
61
  },
65
62
  "files": [
66
63
  "dist"