@lark-apaas/devtool-kits 1.2.15 → 1.2.16-beta.1

package/README.md

@@ -92,6 +92,17 @@ import {
 } from '@apaas/fullstack-toolkits';
 ```
 
+### 兼容工具函数 (Compat)
+```typescript
+import {
+  sendJson,         // 发送 JSON 响应（兼容 Express/Connect）
+  sendError,        // 发送错误响应
+  sendSuccess,      // 发送成功响应
+  getQuery,         // 获取所有查询参数
+  getQueryParam,    // 获取单个查询参数
+} from '@apaas/fullstack-toolkits';
+```
+
 ### 类型定义 (Types)
 ```typescript
 import type {
@@ -171,6 +182,38 @@ export default {
 - 全局中间件应放在路由中间件之前
 - 路由中间件仅处理匹配其挂载路径的请求
 
+### Vite/Connect 兼容性
+
+本工具包原生支持 Vite 开发服务器。`registerMiddlewares` 会自动检测 Vite/Connect 环境，并添加必要的 Express API 兼容层：
+
+- `res.status()` - 设置响应状态码
+- `res.json()` - 发送 JSON 响应
+- `res.send()` - 发送响应
+- `req.query` - 解析后的查询参数
+
+这意味着您可以直接在 Vite 中使用本工具包，无需额外配置。
+
+**兼容工具函数（可选）：**
+
+如果您正在编写自定义中间件并希望同时支持 Express 和 Vite，可以使用导出的兼容工具函数：
+
+```typescript
+import { sendJson, sendError, sendSuccess, getQuery, getQueryParam } from '@lark-apaas/devtool-kits';
+
+// 发送 JSON 响应（自动检测 Express/Connect）
+sendJson(res, { data: 'value' }, 200);
+
+// 发送错误响应
+sendError(res, 'Not found', error, 404);
+
+// 发送成功响应
+sendSuccess(res, { id: 123 });
+
+// 获取查询参数（自动解析 URL 或使用 req.query）
+const query = getQuery(req);
+const page = getQueryParam(req, 'page');
+```
+
 ## 中间件详细说明
 ### Dev Logs 中间件