@maiyunnet/kebab 2.0.6 → 2.0.8

package/sys/route.d.ts

@@ -1,26 +1,60 @@
+/**
+ * Project: Kebab, User: JianSuoQiYue
+ * Date: 2019-4-15 13:40
+ * Last: 2020-4-14 13:52:00, 2022-09-07 01:43:31, 2023-12-29 17:24:03, 2024-2-7 00:28:50, 2024-6-6 15:15:54, 2025-6-13 19:23:53
+ */
 import * as http from 'http';
 import * as http2 from 'http2';
 import * as net from 'net';
 import * as sCtr from './ctr';
 import * as types from '../types';
+/**
+ * --- 清除已经加载的虚拟主机配置文件 ---
+ */
 export declare function clearKebabConfigs(): void;
+/**
+ * --- 若为动态路径则执行此函数，此函数不进行判断 kebab.json 是否存在 ---
+ * @param data 传导的数据
+ */
 export declare function run(data: {
     'req': http2.Http2ServerRequest | http.IncomingMessage;
     'res'?: http2.Http2ServerResponse | http.ServerResponse;
     'socket'?: net.Socket;
     'uri': types.IUrlParse;
+    /** --- 虚拟主机当前动态目录的绝对根目录，末尾带 / --- */
     'rootPath': string;
+    /** --- base url，如 /abc/vhost/，前后都带 / --- */
     'urlBase': string;
+    /** --- 前面不带 /，末尾不一定，以用户请求为准 --- */
     'path': string;
+    /** --- timeout timer --- */
     'timer'?: {
         'timer': NodeJS.Timeout;
         'timeout': number;
         'callback': () => void;
     };
 }): Promise<boolean>;
+/**
+ * --- 删除本次请求所有已上传的临时文件, Mutton: false, Kebab: true ---
+ * @param cctr Ctr 对象 或 files
+ */
 export declare function unlinkUploadFiles(cctr: sCtr.Ctr | Record<string, types.IPostFile | types.IPostFile[]>): Promise<void>;
+/**
+ * --- 等待异步任务结束，并删除临时文件，如果结束后还有事务没关闭，则会在本函数中打印控制台并且写入 log 文件 ---
+ * --- 此时其实已经给客户端返回了，此处等待不消耗客户端的等待时间 ---
+ * @param cctr 要等待的控制器 ---
+ */
 export declare function waitCtr(cctr: sCtr.Ctr): Promise<void>;
+/**
+ * --- 将 POST 数据的值执行 trim ---
+ * @param post
+ */
 export declare function trimPost(post: Record<string, types.Json>): void;
+/**
+ * --- 获取 formdata 的 post ---
+ * @param req 请求头
+ * @param events 文件处理情况
+ */
 export declare function getFormData(req: http2.Http2ServerRequest | http.IncomingMessage, events?: {
     onfilestart?: (name: string) => boolean | undefined;
     onfiledata?: (chunk: Buffer) => void;