@maiyunnet/kebab 2.0.7 → 2.0.9

package/lib/lan.d.ts

@@ -1,9 +1,15 @@
+/**
+ * --- 获取当前网卡的 IP、MAC 信息 ---
+ */
 export declare function card(): Promise<Array<{
     'name': string;
     'mac': string;
     'iPv4': string;
     'iPv6': string;
 }>>;
+/**
+ * --- 扫描发生关联的局域网 IP ---
+ */
 export declare function scan(): Promise<Array<{
     'mac': string;
     'iPv4': string;

package/lib/lan.js

@@ -37,6 +37,9 @@ exports.card = card;
 exports.scan = scan;
 const os = __importStar(require("os"));
 const lCore = __importStar(require("../lib/core"));
+/**
+ * --- 获取当前网卡的 IP、MAC 信息 ---
+ */
 async function card() {
     const result = [];
     let i = 0;
@@ -48,6 +51,7 @@ async function card() {
             continue;
         }
         for (const name in nifs) {
+            /** --- 当前网卡 --- */
             const card = nifs[name];
             if (!card) {
                 continue;
@@ -78,6 +82,9 @@ async function card() {
     }
     return result;
 }
+/**
+ * --- 扫描发生关联的局域网 IP ---
+ */
 async function scan() {
     const result = [];
     const res = await lCore.exec('arp -a');

package/lib/net/formdata.d.ts

@@ -1,23 +1,61 @@
+/**
+ * Project: Kebab, User: JianSuoQiYue
+ * Date: 2020-04-07 23:45:03
+ * Last: 2020-04-07 23:45:07, 2022-09-10 01:35:25
+ */
 import * as stream from 'stream';
+/** --- Item 对象 --- */
 export interface IItem {
+    /** --- key 键 --- */
     'key': string;
     'isFile': boolean;
     'isString': boolean;
+    /** --- 值或者文件名 --- */
     'value': string;
     'path': string;
 }
 export declare class FormData extends stream.Readable {
+    /** --- read 调用次数 --- */
     private _num;
+    /** --- 要编译的数据 --- */
     private readonly _data;
+    /** --- 分隔符 --- */
     private readonly _boundary;
+    /** --- 正在读取文件吗 --- */
     private _fileReading;
+    /** --- 是否已经结束 --- */
     private _close;
+    /** --- 总字节长度 --- */
     private _length;
+    /** --- 已发送字节长度 --- */
     private _sent;
+    /**
+     * --- 添加字符串 ---
+     * @param key 键
+     * @param val 值
+     */
     putString(key: string, val: string): void;
+    /**
+     * --- 添加文件 ---
+     * @param key 键
+     * @param path 路径
+     * @param fname 可选，文件名
+     */
     putFile(key: string, path: string, fname?: string): Promise<boolean>;
+    /**
+     * --- 获取 boundary ---
+     */
     getBoundary(): string;
+    /**
+     * --- 获取总字节长度 ---
+     */
     getLength(): number;
+    /**
+     * --- 获取已发送的字节长度 ---
+     */
     getSent(): number;
+    /**
+     * --- 间隔读取（on data 或 pipe 触发）---
+     */
     _read(): void;
 }

package/lib/net/formdata.js

@@ -34,6 +34,11 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FormData = void 0;
+/**
+ * Project: Kebab, User: JianSuoQiYue
+ * Date: 2020-04-07 23:45:03
+ * Last: 2020-04-07 23:45:07, 2022-09-10 01:35:25
+ */
 const stream = __importStar(require("stream"));
 const mime = __importStar(require("@litert/mime"));
 const core = __importStar(require("../../lib/core"));
@@ -41,14 +46,26 @@ const fs = __importStar(require("../../lib/fs"));
 class FormData extends stream.Readable {
     constructor() {
         super(...arguments);
+        /** --- read 调用次数 --- */
         this._num = 0;
+        /** --- 要编译的数据 --- */
         this._data = [];
+        /** --- 分隔符 --- */
         this._boundary = '----Kebab' + core.random(29, core.RANDOM_LUN);
+        /** --- 正在读取文件吗 --- */
         this._fileReading = false;
+        /** --- 是否已经结束 --- */
         this._close = false;
+        /** --- 总字节长度 --- */
         this._length = 4 + this._boundary.length;
+        /** --- 已发送字节长度 --- */
         this._sent = 0;
     }
+    /**
+     * --- 添加字符串 ---
+     * @param key 键
+     * @param val 值
+     */
     putString(key, val) {
         this._data.push({
             'key': key,
@@ -59,6 +76,12 @@ class FormData extends stream.Readable {
         });
         this._length += this._boundary.length + 49 + Buffer.byteLength(key) + Buffer.byteLength(val);
     }
+    /**
+     * --- 添加文件 ---
+     * @param key 键
+     * @param path 路径
+     * @param fname 可选，文件名
+     */
     async putFile(key, path, fname) {
         path = path.replace(/\\/g, '/');
         const stat = await fs.stats(path);
@@ -81,23 +104,40 @@ class FormData extends stream.Readable {
             mime.getMime(fname).length + stat.size + 2;
         return true;
     }
+    /**
+     * --- 获取 boundary ---
+     */
     getBoundary() {
         return this._boundary;
     }
+    /**
+     * --- 获取总字节长度 ---
+     */
     getLength() {
         return this._length;
     }
+    /**
+     * --- 获取已发送的字节长度 ---
+     */
     getSent() {
         return this._sent;
     }
+    /**
+     * --- 间隔读取（on data 或 pipe 触发）---
+     */
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     _read() {
         if (this._close) {
+            // --- 结束了 ---
             this.push(null);
             return;
         }
+        // --- 文件读取中 ---
         if (this._fileReading) {
+            // --- 等待下面 fileReadable 的 on data 或 end 事件 ---
             return;
         }
+        // --- 获取当前 item ---
         const item = this._data[this._num];
         if (!item) {
             this._close = true;
@@ -107,14 +147,17 @@ class FormData extends stream.Readable {
             return;
         }
         if (item.isString) {
+            // --- 字段 ---
             const push = `--${this._boundary}\r\nContent-Disposition: form-data; name="${item.key}"\r\n\r\n${item.value}\r\n`;
             this._sent += Buffer.byteLength(push);
             this.push(push);
         }
         else {
+            // --- 文件 ---
             const push = `--${this._boundary}\r\nContent-Disposition: form-data; name="${item.key}"; filename="${item.value}"\r\nContent-Type: ${mime.getMime(item.value)}\r\n\r\n`;
             this._sent += Buffer.byteLength(push);
             this.push(push);
+            // --- 创建流 ---
             this._fileReading = true;
             const fileReadable = fs.createReadStream(item.path);
             fileReadable.on('data', (chunk) => {

package/lib/net/request.d.ts

@@ -1,23 +1,85 @@
+/**
+ * Project: Kebab, User: JianSuoQiYue
+ * Date: 2020-4-9 20:02:39
+ * Last: 2020-4-9 20:47:58, 2022-09-10 01:35:34
+ */
 import * as stream from 'stream';
 import * as response from './response';
 import * as types from '../../types';
 export declare class Request {
+    /** --- get 或 post 的数据 --- */
     private _data;
+    /** --- 访问的 URL --- */
     private readonly _url;
+    /** --- 要传递的参数 --- */
     private _opt;
     constructor(url: string);
+    /**
+     * --- 设置 get 或 post 的数据 ---
+     * @param data 数据
+     */
     data(data: Record<string, any> | Buffer | string | stream.Readable): this;
+    /**
+     * --- 设置 get 或 post 请求 ---
+     * @param method
+     */
     method(method: 'GET' | 'POST'): this;
+    /**
+     * --- method get 方法别名 ---
+     */
     get(): this;
+    /**
+     * --- method post 方法别名 ---
+     */
     post(): this;
+    /**
+     * --- 设置提交模式，json 还是普通 form ---
+     * @param type
+     */
     type(type: 'form' | 'json'): this;
+    /**
+     * --- type json 方法别名 ---
+     */
     json(): this;
+    /**
+     * --- 设置请求有效期 ---
+     * @param timeout 秒
+     */
     timeout(timeout: number): this;
+    /**
+     * --- 设置是否跟随请求方的 location，留空为跟随，不设置为不跟随 ---
+     * @param follow
+     */
     follow(follow?: number): this;
+    /**
+     * --- 设置域名 -> ip的对应键值，就像电脑里的 hosts 一样 ---
+     * @param hosts
+     */
     hosts(hosts: Record<string, string>): this;
+    /**
+     * --- 设置后将直接保存到本地文件，不会返回，save 为本地实体路径 ---
+     * @param save
+     */
     save(save: string): this;
+    /**
+     * --- 设置使用的本地网卡 IP ---
+     * @param addr
+     */
     local(addr: string): this;
+    /**
+     * --- 批量设置提交的 headers ---
+     * @param headers
+     */
     headers(headers: types.THttpHeaders): this;
+    /**
+     * --- 设置单条 header ---
+     * @param name
+     * @param val
+     */
     setHeader(name: string, val: string): this;
+    /**
+     * --- 发起请求 ---
+     * @param cookie
+     */
     request(cookie?: Record<string, types.ICookie>): Promise<response.Response>;
 }

package/lib/net/request.js

@@ -37,56 +37,109 @@ exports.Request = void 0;
 const net = __importStar(require("../../lib/net"));
 class Request {
     constructor(url) {
+        /** --- get 或 post 的数据 --- */
         this._data = undefined;
+        /** --- 访问的 URL --- */
         this._url = '';
+        /** --- 要传递的参数 --- */
         this._opt = {};
         this._url = url;
     }
+    /**
+     * --- 设置 get 或 post 的数据 ---
+     * @param data 数据
+     */
     data(data) {
         this._data = data;
         return this;
     }
+    /**
+     * --- 设置 get 或 post 请求 ---
+     * @param method
+     */
     method(method) {
         this._opt['method'] = method;
         return this;
     }
+    /**
+     * --- method get 方法别名 ---
+     */
     get() {
         return this.method('GET');
     }
+    /**
+     * --- method post 方法别名 ---
+     */
     post() {
         return this.method('POST');
     }
+    /**
+     * --- 设置提交模式，json 还是普通 form ---
+     * @param type
+     */
     type(type) {
         this._opt['type'] = type;
         return this;
     }
+    /**
+     * --- type json 方法别名 ---
+     */
     json() {
         return this.type('json');
     }
+    /**
+     * --- 设置请求有效期 ---
+     * @param timeout 秒
+     */
     timeout(timeout) {
         this._opt['timeout'] = timeout;
         return this;
     }
+    /**
+     * --- 设置是否跟随请求方的 location，留空为跟随，不设置为不跟随 ---
+     * @param follow
+     */
     follow(follow = 5) {
         this._opt['follow'] = follow;
         return this;
     }
+    /**
+     * --- 设置域名 -> ip的对应键值，就像电脑里的 hosts 一样 ---
+     * @param hosts
+     */
     hosts(hosts) {
         this._opt['hosts'] = hosts;
         return this;
     }
+    /**
+     * --- 设置后将直接保存到本地文件，不会返回，save 为本地实体路径 ---
+     * @param save
+     */
     save(save) {
         this._opt['save'] = save;
         return this;
     }
+    /**
+     * --- 设置使用的本地网卡 IP ---
+     * @param addr
+     */
     local(addr) {
         this._opt['local'] = addr;
         return this;
     }
+    /**
+     * --- 批量设置提交的 headers ---
+     * @param headers
+     */
     headers(headers) {
         this._opt['headers'] = headers;
         return this;
     }
+    /**
+     * --- 设置单条 header ---
+     * @param name
+     * @param val
+     */
     setHeader(name, val) {
         if (!this._opt['headers']) {
             this._opt['headers'] = {};
@@ -94,6 +147,10 @@ class Request {
         this._opt['headers'][name] = val;
         return this;
     }
+    /**
+     * --- 发起请求 ---
+     * @param cookie
+     */
     async request(cookie) {
         this._opt.cookie = cookie;
         return net.request(this._url, this._data, this._opt);

package/lib/net/response.d.ts

@@ -1,14 +1,35 @@
+/**
+ * Project: Kebab, User: JianSuoQiYue
+ * Date: 2020-4-9 15:33:06
+ * Last: 2020-4-12 11:12:03, 2022-09-10 12:43:23, 2022-12-25 15:12:57, 2023-9-26 14:20:41
+ */
 import * as hc from '@litert/http-client';
 import * as nStream from 'stream';
 import * as types from '../../types';
 export declare class Response {
+    /** --- httpClient 请求对象 --- */
     private readonly _req;
+    /** --- 返回的 headers --- */
     headers: types.THttpHeaders | null;
     error: Error | null;
+    /** --- 用户自定义的 content 内容 --- */
     private _content;
     constructor(req: hc.IResponse | null);
+    /**
+     * --- 读取所有内容到内存 ---
+     */
     getContent(): Promise<Buffer | null>;
+    /**
+     * --- 用户自定义的 content 内容 ---
+     * @param v 内容值
+     */
     setContent(v: string | Buffer): void;
+    /**
+     * --- 获取响应读取流对象 ---
+     */
     getStream(): nStream.Readable;
+    /**
+     * --- 获取原生响应读取流对象 ---
+     */
     getRawStream(): nStream.Readable;
 }

package/lib/net/response.js

@@ -3,24 +3,40 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Response = void 0;
 class Response {
     constructor(req) {
+        /** --- httpClient 请求对象 --- */
         this._req = null;
+        /** --- 返回的 headers --- */
         this.headers = null;
         this.error = null;
+        /** --- 用户自定义的 content 内容 --- */
         this._content = null;
         this._req = req;
     }
+    /**
+     * --- 读取所有内容到内存 ---
+     */
     async getContent() {
         if (this._content) {
             return this._content;
         }
         return this._req ? this._req.getBuffer() : null;
     }
+    /**
+     * --- 用户自定义的 content 内容 ---
+     * @param v 内容值
+     */
     setContent(v) {
         this._content = typeof v === 'string' ? Buffer.from(v) : v;
     }
+    /**
+     * --- 获取响应读取流对象 ---
+     */
     getStream() {
         return this._req.getStream();
     }
+    /**
+     * --- 获取原生响应读取流对象 ---
+     */
     getRawStream() {
         return this._req.getRawStream();
     }

package/lib/net.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Project: Kebab, User: JianSuoQiYue
+ * Date: 2019-5-15 22:47
+ * CA: https://curl.haxx.se/ca/cacert.pem
+ * Last: 2020-4-9 20:11:02, 2022-09-22 14:30:13, 2024-1-1 21:32:26, 2024-1-12 13:01:54, 2025-6-13 13:20:52
+ */
 import * as stream from 'stream';
 import * as http from 'http';
 import * as http2 from 'http2';
@@ -6,60 +12,140 @@ import * as types from '../types';
 import * as fd from './net/formdata';
 import * as lRequest from './net/request';
 import * as response from './net/response';
+/** --- 请求的传入参数选项 --- */
 export interface IRequestOptions {
     'method'?: 'GET' | 'POST' | 'OPTIONS';
     'type'?: 'form' | 'json';
+    /** --- 秒数 --- */
     'timeout'?: number;
     'follow'?: number;
     'hosts'?: Record<string, string>;
     'save'?: string;
     'local'?: string;
     'headers'?: types.THttpHeaders;
+    /** --- 正向 mproxy 代理，url 如 https://xxx/abc --- */
     'mproxy'?: {
         'url': string;
         'auth': string;
         'data'?: any;
     };
+    /** --- 默认为 default --- */
     'reuse'?: string;
+    /** --- cookie 托管对象 --- */
     'cookie'?: Record<string, types.ICookie>;
 }
+/** --- 正向代理请求的传入参数选项 --- */
 export interface IMproxyOptions {
+    /** --- 秒数 --- */
     'timeout'?: number;
     'follow'?: number;
     'hosts'?: Record<string, string>;
     'local'?: string;
     'headers'?: types.THttpHeaders;
+    /** --- 默认为 default --- */
     'reuse'?: string;
 }
+/** --- 反向代理请求的传入参数选项 --- */
 export interface IRproxyOptions {
+    /** --- 秒数 --- */
     'timeout'?: number;
     'follow'?: number;
     'hosts'?: Record<string, string>;
     'local'?: string;
     'headers'?: types.THttpHeaders;
+    /** --- 正向 mproxy 代理，url 如 https://xxx/abc --- */
     'mproxy'?: {
         'url': string;
         'auth': string;
         'data'?: any;
     };
+    /** --- 默认为 default --- */
     'reuse'?: string;
 }
+/** --- 获取 CA 证书 --- */
 export declare function getCa(): Promise<string>;
+/**
+ * --- 创建一个请求对象 ---
+ * @param u
+ */
 export declare function open(u: string): lRequest.Request;
+/**
+ * --- 发起一个 get 请求 ---
+ * @param u 请求的 URL
+ * @param opt 参数
+ */
 export declare function get(u: string, opt?: IRequestOptions): Promise<response.Response>;
+/**
+ * --- 发起一个 post 请求 ---
+ * @param u 请求的 URL
+ * @param data 要发送的数据
+ * @param opt 参数
+ */
 export declare function post(u: string, data: Record<string, types.Json> | Buffer | string | stream.Readable, opt?: IRequestOptions): Promise<response.Response>;
+/**
+ * --- 发起 JSON 请求 ---
+ * @param u
+ * @param data
+ * @param opt
+ */
 export declare function postJson(u: string, data: types.Json[] | Record<string, types.Json>, opt?: IRequestOptions): Promise<response.Response>;
+/**
+ * --- 发起一个请求 ---
+ * @param opt 配置项
+ */
 export declare function request(u: string, data?: Record<string, types.Json> | Buffer | string | stream.Readable, opt?: IRequestOptions): Promise<response.Response>;
+/**
+ * --- 对 cookie 对象进行操作 ---
+ * @param cookie 要操作的对象
+ * @param name 名
+ * @param value 值
+ * @param domain 应用网址，如 .xxx.com
+ * @param opt 选项 ttl, path, ssl, httponly
+ */
 export declare function setCookie(cookie: Record<string, types.ICookie>, name: string, value: string, domain: string, opt?: {
     'ttl'?: number;
     'path'?: string;
     'ssl'?: boolean;
     'httponly'?: boolean;
 }): void;
+/**
+ * --- 对象转换为 Cookie 拼接字符串（会自动筛掉不能发送的 cookie） ---
+ * @param cookie cookie 对象
+ * @param uri 请求的 URI 对象
+ */
 export declare function buildCookieQuery(cookie: Record<string, types.ICookie>, uri: types.IUrlParse): string;
+/**
+ * --- 模拟重启浏览器后的状态 ---
+ * @param cookie cookie 对象
+ */
 export declare function resetCookieSession(cookie: Record<string, types.ICookie>): void;
+/**
+ * --- 创建 FormData 对象, Mutton: false, Kebab: true ---
+ */
 export declare function getFormData(): fd.FormData;
+/**
+ * --- 剔除不代理的 header ---
+ * @param headers 剔除前的 header
+ * @param res 直接设置头部而不返回，可置空
+ */
 export declare function filterProxyHeaders(headers: http.IncomingHttpHeaders | http2.IncomingHttpHeaders | types.THttpHeaders, res?: http2.Http2ServerResponse | http.ServerResponse): Record<string, string | string[]>;
+/**
+ * --- 正向 mproxy 代理，读取 get 的 url 为实际请求地址 ---
+ * --- get: url, auth ---
+ * @param ctr 当前控制器
+ * @param auth 校验字符串，读取 get 的 auth 和本参数做比对
+ * @param opt 参数
+ */
 export declare function mproxy(ctr: ctr.Ctr, auth: string, opt?: IMproxyOptions): Promise<number>;
+/**
+ * --- 获取 mproxy 的附加数据 ---
+ * @param ctr 当前控制器
+ */
 export declare function mproxyData(ctr: ctr.Ctr): any;
+/**
+ * --- 反向代理，将本服务器的某个路由反代到其他网址 ---
+ * @param ctr 当前控制器
+ * @param route 要反代的路由
+ * @param opt 参数
+ */
 export declare function rproxy(ctr: ctr.Ctr, route: Record<string, string>, opt?: IRproxyOptions): Promise<boolean>;