streamline-code-by-ikun2274 0.12.2 → 0.12.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "streamline-code-by-ikun2274",
-  "version": "0.12.2",
+  "version": "0.12.4",
   "description": "A streamline Express route builder with database operations, pagination, and authentication",
   "main": "src/StreamlineCodeIndex.js",
   "exports": {
@@ -10,6 +10,7 @@
 
     }
   },
+  "types": "./types/index.d.ts",
   "scripts": {
 
   },

package/types/index.d.ts

@@ -150,6 +150,26 @@ export interface ToolDb {
  * @param {string} [options.PlusHandler.other.errorMessage='操作失败'] - 错误消息（可选）
  * 
  */
+/**
+ * 二次封装 defineRoute 函数
+ * @param options 路由配置选项
+ * @param options.url 路由路径（必填）
+ * @param options.method HTTP 方法（GET/POST/PUT/DELETE，必填）
+ * @param options.middlewares 中间件数组（可选 用户自定义中间件）
+ * @param options.BuiltinMid 内置中间件配置，填一个激活一个
+ * @param options.autoGenerateId 自动生成 ID，默认为 false
+ * @param options.PlusHandler 额外处理选项（必填）
+ * @param options.PlusHandler.db 数据库操作（必填）
+ * @param options.PlusHandler.db.table 数据库表名（必填）
+ * @param options.PlusHandler.db.operation 数据表操作（必填）select/insert/update/delete
+ * @param options.PlusHandler.db.primaryKey 主键字段，默认为 'id'
+ * @param options.PlusHandler.db.fields 查询字段，默认为 '*'
+ * @param options.PlusHandler.db.categoryField 分类字段，默认为 'category_id'
+ * @param options.PlusHandler.other 其他选项（必填）
+ * @param options.PlusHandler.other.customLogic 自定义逻辑函数
+ * @param options.PlusHandler.other.successMessage 成功消息，默认为 '操作成功'
+ * @param options.PlusHandler.other.errorMessage 错误消息，默认为 '操作失败'
+ */
 export function DefineRoutePlus_A(options: RouteConfig): void;
 
 /**
@@ -182,6 +202,17 @@ export function setDbConfig(config: Partial<DbConfig>): void;
  */
 export function query(sql: string, params?: any[]): Promise<any>;
 
+/**
+ * 启动服务器
+ * @param options 配置选项
+ * @param options.port 服务器端口，默认3001
+ * @param options.allowedOrigins 允许的域名列表
+ */
+export function startServer(options?: {
+  port?: number;
+  allowedOrigins?: string[];
+}): void;
+
 /**
  * Express 应用实例
  */