@kivii.com/bridge 1.1.1 → 1.1.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.
- package/README.md +23 -48
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -29,7 +29,7 @@ pnpm add "@Kivii.com/bridge"
|
|
|
29
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,12 @@ src/
|
|
|
88
88
|
### 配置管理
|
|
89
89
|
|
|
90
90
|
```javascript
|
|
91
|
-
import { Kivii } from '@Kivii.com/bridge';
|
|
92
|
-
|
|
93
91
|
// 设置配置
|
|
94
|
-
|
|
95
|
-
|
|
92
|
+
kivii.config.set('request.baseURL', 'https://api.example.com');
|
|
93
|
+
kivii.config.set('request.timeout', 5000);
|
|
96
94
|
|
|
97
95
|
// 获取配置
|
|
98
|
-
const baseURL =
|
|
96
|
+
const baseURL = kivii.config.get('request.baseURL');
|
|
99
97
|
```
|
|
100
98
|
|
|
101
99
|
**📖 详细文档:[配置管理 API](./src/docs/config.md)**
|
|
@@ -104,7 +102,7 @@ const baseURL = Kivii.config.get('request.baseURL');
|
|
|
104
102
|
|
|
105
103
|
```javascript
|
|
106
104
|
// 示例一
|
|
107
|
-
|
|
105
|
+
kivii.request
|
|
108
106
|
.send({
|
|
109
107
|
url: 'ai/chat/test',
|
|
110
108
|
method: 'POST',
|
|
@@ -118,12 +116,12 @@ Kivii.request
|
|
|
118
116
|
});
|
|
119
117
|
|
|
120
118
|
// 示例二
|
|
121
|
-
const response = await
|
|
119
|
+
const response = await kivii.request.get('ai/chat/test');
|
|
122
120
|
console.log(response);
|
|
123
121
|
|
|
124
122
|
// 示例三 封装成方法后必须使用async
|
|
125
123
|
const getChatTest = async () => {
|
|
126
|
-
return await
|
|
124
|
+
return await kivii.request.get('ai/chat/test');
|
|
127
125
|
};
|
|
128
126
|
const response3 = await getChatTest(); // 或 getChatTest().then((res: any) => { console.log(res); })
|
|
129
127
|
console.log(response3);
|
|
@@ -134,12 +132,10 @@ console.log(response3);
|
|
|
134
132
|
### 日志记录
|
|
135
133
|
|
|
136
134
|
```javascript
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
Kivii.logger.warn('警告信息');
|
|
142
|
-
Kivii.logger.error('错误信息', new Error('Something went wrong'));
|
|
135
|
+
kivii.logger.debug('调试信息', { userId: 123 });
|
|
136
|
+
kivii.logger.info('应用启动成功');
|
|
137
|
+
kivii.logger.warn('警告信息');
|
|
138
|
+
kivii.logger.error('错误信息', new Error('Something went wrong'));
|
|
143
139
|
```
|
|
144
140
|
|
|
145
141
|
**📖 详细文档:[Logger 模块 API](./src/docs/logger.md)**
|
|
@@ -147,13 +143,15 @@ Kivii.logger.error('错误信息', new Error('Something went wrong'));
|
|
|
147
143
|
### Mock 请求
|
|
148
144
|
|
|
149
145
|
```javascript
|
|
150
|
-
|
|
146
|
+
// main.ts
|
|
147
|
+
import kivii from '@Kivii.com/bridge';
|
|
148
|
+
import { MockRequest, AxiosRequest } from '@Kivii.com/bridge';
|
|
151
149
|
|
|
152
150
|
// 注册 MockRequest 模块
|
|
153
|
-
|
|
151
|
+
kivii.register(new MockRequest());
|
|
154
152
|
|
|
155
153
|
// 配置 mock 数据
|
|
156
|
-
|
|
154
|
+
kivii.config.set('mock', {
|
|
157
155
|
api: {
|
|
158
156
|
users: [
|
|
159
157
|
{ id: 1, name: 'John Doe', email: 'john@example.com' },
|
|
@@ -163,11 +161,10 @@ Kivii.config.set('mock', {
|
|
|
163
161
|
});
|
|
164
162
|
|
|
165
163
|
// 使用 mock 数据发送请求
|
|
166
|
-
const response = await
|
|
164
|
+
const response = await kivii.request.get('/api/users');
|
|
167
165
|
console.log(response.data); // [{ id: 1, name: 'John Doe', ... }, ...]
|
|
168
166
|
|
|
169
|
-
//
|
|
170
|
-
Kivii.register(new AxiosRequest());
|
|
167
|
+
// 切换到真实请求直接在main.ts里注释 kivii.register(new MockRequest());
|
|
171
168
|
```
|
|
172
169
|
|
|
173
170
|
**📖 详细文档:[Mock 模块 API](./src/docs/mock.md)**
|
|
@@ -175,7 +172,7 @@ Kivii.register(new AxiosRequest());
|
|
|
175
172
|
### 依赖注入
|
|
176
173
|
|
|
177
174
|
```javascript
|
|
178
|
-
import
|
|
175
|
+
import kivii from '@Kivii.com/bridge';
|
|
179
176
|
|
|
180
177
|
// 自定义请求模块
|
|
181
178
|
class CustomRequest {
|
|
@@ -197,30 +194,8 @@ class CustomRequest {
|
|
|
197
194
|
}
|
|
198
195
|
}
|
|
199
196
|
|
|
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 - 本地存储模块类
|
|
197
|
+
// 注册自定义模块
|
|
198
|
+
kivii.register(new CustomRequest());
|
|
224
199
|
```
|
|
225
200
|
|
|
226
201
|
## 🧪 测试
|