@yxw007/translate 0.0.1-alpha.3 → 0.0.2

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 (12) hide show
  1. package/README.md +46 -15
  2. package/README_zh-CN.md +44 -14
  3. package/dist/browser/index.cjs +1 -1
  4. package/dist/browser/index.umd.js +1 -1
  5. package/dist/node/index.cjs +1 -1
  6. package/dist/node/index.js +1 -1
  7. package/dist/package.json +1 -5
  8. package/package.json +1 -5
  9. package/dist/node/index.min.cjs +0 -2
  10. package/dist/node/index.min.cjs.map +0 -1
  11. package/dist/node/index.min.js +0 -2
  12. package/dist/node/index.min.js.map +0 -1
package/README.md CHANGED
@@ -46,11 +46,20 @@ English | [简体中文](./README_zh-CN.md)
46
46
 
47
47
  ## 📖 Usage
48
48
 
49
- - ESM
49
+ ### Node
50
50
 
51
+ - ESM
51
52
  ```typescript
52
53
  import { translator, engines } from "@yxw007/translate"
54
+ ```
55
+
56
+ - Commonjs
57
+ ```typescript
58
+ const { translator, engines } = required("@yxw007/translate")
59
+ ```
53
60
 
61
+ - example
62
+ ```typescript
54
63
  translator.use(engines.google());
55
64
  const res1 = await translator.translate("hello", { from: "en", to: "zh" });
56
65
  console.log(res1);
@@ -59,32 +68,54 @@ English | [简体中文](./README_zh-CN.md)
59
68
  console.log(res2);
60
69
  ```
61
70
 
62
- output
71
+ 输出结果
63
72
  ```bash
64
73
  ['你好']
65
74
  ["你好", "好的"]
66
75
  ```
67
76
 
68
- - Commonjs
77
+ ### Browser
69
78
 
70
- ```typescript
71
- const { translator, engines } = required("@yxw007/translate")
72
-
73
- translator.use(engines.google());
74
- const res1 = await translator.translate("hello", { from: "en", to: "zh" });
75
- console.log(res1);
79
+ use jsDelivr CDN
76
80
 
77
- const res2 = await translator.translate(["hello", "good"], { from: "en", to: "zh", engine: "google" });
78
- console.log(res2);
81
+ - `development`
82
+ ```html
83
+ <script src="https://cdn.jsdelivr.net/npm/@yxw007/translate@0.0.1-alpha.3/dist/browser/index.umd.js"></script>
84
+ ```
85
+
86
+ - `production`
79
87
 
88
+ ```html
89
+ <script src="https://cdn.jsdelivr.net/npm/@yxw007/translate@0.0.1-alpha.3/dist/browser/index.umd.min.js"></script>
80
90
  ```
81
91
 
82
- output
83
- ```bash
84
- ['你好']
85
- ["你好", "好的"]
92
+ - example
93
+
94
+ ```html
95
+ <!DOCTYPE html>
96
+ ...
97
+
98
+ <head>
99
+ ...
100
+ <script src="https://cdn.jsdelivr.net/npm/@yxw007/translate@0.0.1-alpha.3/dist/browser/index.umd.js"></script>
101
+ </head>
102
+
103
+ <body>
104
+ <script>
105
+ (async () => {
106
+ const { engines, translator } = translate;
107
+ translator.use(engines.google());
108
+ const res = await translator.translate("hello", { from: "en", to: "zh" });
109
+ console.log(res);
110
+ })();
111
+ </script>
112
+ </body>
113
+
114
+ </html>
115
+
86
116
  ```
87
117
 
118
+
88
119
  ## 📚 API
89
120
 
90
121
  ### Translator
package/README_zh-CN.md CHANGED
@@ -59,11 +59,20 @@ Translate 是一个支持多翻译引擎的翻译工具库，它提供了一套
59
59
 
60
60
  ## 📖 使用
61
61
 
62
- - ESM
62
+ ### Node
63
63
 
64
+ - ESM
64
65
  ```typescript
65
66
  import { translator, engines } from "@yxw007/translate"
67
+ ```
68
+
69
+ - Commonjs
70
+ ```typescript
71
+ const { translator, engines } = required("@yxw007/translate")
72
+ ```
66
73
 
74
+ - example
75
+ ```typescript
67
76
  translator.use(engines.google());
68
77
  const res1 = await translator.translate("hello", { from: "en", to: "zh" });
69
78
  console.log(res1);
@@ -78,24 +87,45 @@ Translate 是一个支持多翻译引擎的翻译工具库，它提供了一套
78
87
  ["你好", "好的"]
79
88
  ```
80
89
 
81
- - Commonjs
90
+ ### Browser
82
91
 
83
- ```typescript
84
- const { translator, engines } = required("@yxw007/translate")
85
-
86
- translator.use(engines.google());
87
- const res1 = await translator.translate("hello", { from: "en", to: "zh" });
88
- console.log(res1);
92
+ 使用 jsDelivr CDN
89
93
 
90
- const res2 = await translator.translate(["hello", "good"], { from: "en", to: "zh", engine: "google" });
91
- console.log(res2);
94
+ - `development`
95
+ ```html
96
+ <script src="https://cdn.jsdelivr.net/npm/@yxw007/translate@0.0.1-alpha.3/dist/browser/index.umd.js"></script>
97
+ ```
98
+
99
+ - `production`
92
100
 
101
+ ```html
102
+ <script src="https://cdn.jsdelivr.net/npm/@yxw007/translate@0.0.1-alpha.3/dist/browser/index.umd.min.js"></script>
93
103
  ```
94
104
 
95
- 输出结果
96
- ```bash
97
- ['你好']
98
- ["你好", "好的"]
105
+ - example
106
+
107
+ ```html
108
+ <!DOCTYPE html>
109
+ ...
110
+
111
+ <head>
112
+ ...
113
+ <script src="https://cdn.jsdelivr.net/npm/@yxw007/translate@0.0.1-alpha.3/dist/browser/index.umd.js"></script>
114
+ </head>
115
+
116
+ <body>
117
+ <script>
118
+ (async () => {
119
+ const { engines, translator } = translate;
120
+ translator.use(engines.google());
121
+ const res = await translator.translate("hello", { from: "en", to: "zh" });
122
+ console.log(res);
123
+ })();
124
+ </script>
125
+ </body>
126
+
127
+ </html>
128
+
99
129
  ```
100
130
 
101
131
  ## 📚 API
package/dist/browser/index.cjs CHANGED
@@ -1,4 +1,4 @@
1
- // translate v0.0.1-alpha.3 Copyright (c) 2024 Potter<aa4790139@gmail.com> and contributors
1
+ // translate v0.0.2 Copyright (c) 2024 Potter<aa4790139@gmail.com> and contributors
2
2
  'use strict';
3
3
 
4
4
  Object.defineProperty(exports, '__esModule', { value: true });
package/dist/browser/index.umd.js CHANGED
@@ -1,4 +1,4 @@
1
- // translate v0.0.1-alpha.3 Copyright (c) 2024 Potter<aa4790139@gmail.com> and contributors
1
+ // translate v0.0.2 Copyright (c) 2024 Potter<aa4790139@gmail.com> and contributors
2
2
  (function (global, factory) {
3
3
  typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
4
4
  typeof define === 'function' && define.amd ? define(['exports'], factory) :
package/dist/node/index.cjs CHANGED
@@ -1,4 +1,4 @@
1
- // translate v0.0.1-alpha.3 Copyright (c) 2024 Potter<aa4790139@gmail.com> and contributors
1
+ // translate v0.0.2 Copyright (c) 2024 Potter<aa4790139@gmail.com> and contributors
2
2
  'use strict';
3
3
 
4
4
  Object.defineProperty(exports, '__esModule', { value: true });
package/dist/node/index.js CHANGED
@@ -1,4 +1,4 @@
1
- // translate v0.0.1-alpha.3 Copyright (c) 2024 Potter<aa4790139@gmail.com> and contributors
1
+ // translate v0.0.2 Copyright (c) 2024 Potter<aa4790139@gmail.com> and contributors
2
2
  import { Buffer as Buffer$1 } from 'buffer';
3
3
  import { Readable, Writable } from 'stream';
4
4
  import { Agent, request as request$1 } from 'http';
package/dist/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@yxw007/translate",
3
- "version": "0.0.1-alpha.3",
3
+ "version": "0.0.2",
4
4
  "description": "A simple library that supports multiple translation engines",
5
5
  "author": "Potter<aa4790139@gmail.com>",
6
6
  "homepage": "https://github.com/yxw007/translate",
@@ -30,10 +30,6 @@
30
30
  "types": "./dist/index.d.ts",
31
31
  "exports": {
32
32
  ".": {
33
- "types": {
34
- "require": "./dist/index.d.ts",
35
- "default": "./dist/index.d.ts"
36
- },
37
33
  "browser": {
38
34
  "require": "./dist/browser/index.cjs",
39
35
  "default": "./dist/browser/index.js"
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@yxw007/translate",
3
- "version": "0.0.1-alpha.3",
3
+ "version": "0.0.2",
4
4
  "description": "A simple library that supports multiple translation engines",
5
5
  "author": "Potter<aa4790139@gmail.com>",
6
6
  "homepage": "https://github.com/yxw007/translate",
@@ -20,10 +20,6 @@
20
20
  "types": "./dist/index.d.ts",
21
21
  "exports": {
22
22
  ".": {
23
- "types": {
24
- "require": "./dist/index.d.ts",
25
- "default": "./dist/index.d.ts"
26
- },
27
23
  "browser": {
28
24
  "require": "./dist/browser/index.cjs",
29
25
  "default": "./dist/browser/index.js"