@kivii.com/bridge 1.1.1 → 1.1.3
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.
- package/README.md +37 -50
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
### pnpm
|
|
18
18
|
|
|
19
19
|
```bash
|
|
20
|
-
pnpm add "@
|
|
20
|
+
pnpm add "@kivii.com/bridge"
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
## 🚀 快速开始
|
|
@@ -26,10 +26,10 @@ pnpm add "@Kivii.com/bridge"
|
|
|
26
26
|
|
|
27
27
|
```html
|
|
28
28
|
<!-- 使用 UMD 格式 -->
|
|
29
|
-
<script src="https://unpkg.com/@
|
|
29
|
+
<script src="https://unpkg.com/@kivii.com/bridge/dist/kivii.bridge.min.js"></script>
|
|
30
30
|
<script>
|
|
31
31
|
// 访问全局 Kivii 实例
|
|
32
|
-
|
|
32
|
+
kivii.logger.info('应用已加载');
|
|
33
33
|
</script>
|
|
34
34
|
```
|
|
35
35
|
|
|
@@ -37,7 +37,7 @@ pnpm add "@Kivii.com/bridge"
|
|
|
37
37
|
|
|
38
38
|
```javascript
|
|
39
39
|
import { createApp } from 'vue';
|
|
40
|
-
import
|
|
40
|
+
import { kivii } from '@kivii.com/bridge'; // 直接引入就能用,内部已经做全局声明window.Kivii
|
|
41
41
|
import App from './App.vue';
|
|
42
42
|
|
|
43
43
|
const app = createApp(App);
|
|
@@ -50,7 +50,7 @@ app.mount('#app');
|
|
|
50
50
|
```vue
|
|
51
51
|
<script setup>
|
|
52
52
|
// 发送请求
|
|
53
|
-
const response = await
|
|
53
|
+
const response = await kivii.request.send({
|
|
54
54
|
url: '/api/data',
|
|
55
55
|
method: 'GET',
|
|
56
56
|
});
|
|
@@ -88,14 +88,24 @@ src/
|
|
|
88
88
|
### 配置管理
|
|
89
89
|
|
|
90
90
|
```javascript
|
|
91
|
-
|
|
91
|
+
// 初始化配置
|
|
92
|
+
kivii.config.init({
|
|
93
|
+
request: {
|
|
94
|
+
baseURL: 'https://api.example.com',
|
|
95
|
+
timeout: 5000,
|
|
96
|
+
},
|
|
97
|
+
logger: {
|
|
98
|
+
enabled: true,
|
|
99
|
+
level: 'info',
|
|
100
|
+
},
|
|
101
|
+
});
|
|
92
102
|
|
|
93
|
-
//
|
|
94
|
-
|
|
95
|
-
Kivii.config.set('request.timeout', 5000);
|
|
103
|
+
// 单独设置配置
|
|
104
|
+
kivii.config.set('version', '1.0.0');
|
|
96
105
|
|
|
97
106
|
// 获取配置
|
|
98
|
-
const baseURL =
|
|
107
|
+
const baseURL = kivii.config.get('request.baseURL');
|
|
108
|
+
const appName = kivii.config.get('name');
|
|
99
109
|
```
|
|
100
110
|
|
|
101
111
|
**📖 详细文档:[配置管理 API](./src/docs/config.md)**
|
|
@@ -104,7 +114,7 @@ const baseURL = Kivii.config.get('request.baseURL');
|
|
|
104
114
|
|
|
105
115
|
```javascript
|
|
106
116
|
// 示例一
|
|
107
|
-
|
|
117
|
+
kivii.request
|
|
108
118
|
.send({
|
|
109
119
|
url: 'ai/chat/test',
|
|
110
120
|
method: 'POST',
|
|
@@ -118,12 +128,12 @@ Kivii.request
|
|
|
118
128
|
});
|
|
119
129
|
|
|
120
130
|
// 示例二
|
|
121
|
-
const response = await
|
|
131
|
+
const response = await kivii.request.get('ai/chat/test');
|
|
122
132
|
console.log(response);
|
|
123
133
|
|
|
124
134
|
// 示例三 封装成方法后必须使用async
|
|
125
135
|
const getChatTest = async () => {
|
|
126
|
-
return await
|
|
136
|
+
return await kivii.request.get('ai/chat/test');
|
|
127
137
|
};
|
|
128
138
|
const response3 = await getChatTest(); // 或 getChatTest().then((res: any) => { console.log(res); })
|
|
129
139
|
console.log(response3);
|
|
@@ -134,12 +144,10 @@ console.log(response3);
|
|
|
134
144
|
### 日志记录
|
|
135
145
|
|
|
136
146
|
```javascript
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
Kivii.logger.warn('警告信息');
|
|
142
|
-
Kivii.logger.error('错误信息', new Error('Something went wrong'));
|
|
147
|
+
kivii.logger.debug('调试信息', { userId: 123 });
|
|
148
|
+
kivii.logger.info('应用启动成功');
|
|
149
|
+
kivii.logger.warn('警告信息');
|
|
150
|
+
kivii.logger.error('错误信息', new Error('Something went wrong'));
|
|
143
151
|
```
|
|
144
152
|
|
|
145
153
|
**📖 详细文档:[Logger 模块 API](./src/docs/logger.md)**
|
|
@@ -147,13 +155,15 @@ Kivii.logger.error('错误信息', new Error('Something went wrong'));
|
|
|
147
155
|
### Mock 请求
|
|
148
156
|
|
|
149
157
|
```javascript
|
|
150
|
-
|
|
158
|
+
// main.ts
|
|
159
|
+
import kivii from '@kivii.com/bridge';
|
|
160
|
+
import { MockRequest, AxiosRequest } from '@kivii.com/bridge';
|
|
151
161
|
|
|
152
162
|
// 注册 MockRequest 模块
|
|
153
|
-
|
|
163
|
+
kivii.register(new MockRequest());
|
|
154
164
|
|
|
155
165
|
// 配置 mock 数据
|
|
156
|
-
|
|
166
|
+
kivii.config.set('mock', {
|
|
157
167
|
api: {
|
|
158
168
|
users: [
|
|
159
169
|
{ id: 1, name: 'John Doe', email: 'john@example.com' },
|
|
@@ -163,11 +173,10 @@ Kivii.config.set('mock', {
|
|
|
163
173
|
});
|
|
164
174
|
|
|
165
175
|
// 使用 mock 数据发送请求
|
|
166
|
-
const response = await
|
|
176
|
+
const response = await kivii.request.get('/api/users');
|
|
167
177
|
console.log(response.data); // [{ id: 1, name: 'John Doe', ... }, ...]
|
|
168
178
|
|
|
169
|
-
//
|
|
170
|
-
Kivii.register(new AxiosRequest());
|
|
179
|
+
// 切换到真实请求直接在main.ts里注释 kivii.register(new MockRequest());
|
|
171
180
|
```
|
|
172
181
|
|
|
173
182
|
**📖 详细文档:[Mock 模块 API](./src/docs/mock.md)**
|
|
@@ -175,7 +184,7 @@ Kivii.register(new AxiosRequest());
|
|
|
175
184
|
### 依赖注入
|
|
176
185
|
|
|
177
186
|
```javascript
|
|
178
|
-
import
|
|
187
|
+
import kivii from '@kivii.com/bridge';
|
|
179
188
|
|
|
180
189
|
// 自定义请求模块
|
|
181
190
|
class CustomRequest {
|
|
@@ -197,30 +206,8 @@ class CustomRequest {
|
|
|
197
206
|
}
|
|
198
207
|
}
|
|
199
208
|
|
|
200
|
-
//
|
|
201
|
-
|
|
202
|
-
```
|
|
203
|
-
|
|
204
|
-
## 🎯 导出说明
|
|
205
|
-
|
|
206
|
-
### 默认导出
|
|
207
|
-
|
|
208
|
-
```javascript
|
|
209
|
-
import KiviiBridge from '@Kivii.com/bridge';
|
|
210
|
-
// KiviiBridge = { install, Kivii }
|
|
211
|
-
// 适用于 Vue 插件方式:app.use(KiviiBridge)
|
|
212
|
-
// 或访问实例:KiviiBridge.Kivii
|
|
213
|
-
```
|
|
214
|
-
|
|
215
|
-
### 命名导出
|
|
216
|
-
|
|
217
|
-
```javascript
|
|
218
|
-
import { Kivii, AxiosRequest, MockRequest, ConsoleLogger, LocalStorage } from '@Kivii.com/bridge';
|
|
219
|
-
// Kivii - Kivii 核心类
|
|
220
|
-
// AxiosRequest - Axios 请求模块类
|
|
221
|
-
// MockRequest - Mock 请求模块类
|
|
222
|
-
// ConsoleLogger - 控制台日志模块类
|
|
223
|
-
// LocalStorage - 本地存储模块类
|
|
209
|
+
// 注册自定义模块
|
|
210
|
+
kivii.register(new CustomRequest());
|
|
224
211
|
```
|
|
225
212
|
|
|
226
213
|
## 🧪 测试
|