xshell 1.3.5 → 1.3.6

package/net.d.ts

@@ -2,7 +2,7 @@ import net from 'node:net';
 import { type Readable } from 'node:stream';
 import type { Cookie, CookieJar, MemoryCookieStore } from 'tough-cookie';
 import type { Encoding } from './file.ts';
-import { inspect, type Deferred2 } from './utils.ts';
+import { inspect, type Deferred2, type OnTimeout } from './utils.ts';
 import { type BasicAuth, type BearerAuth } from './net.common.ts';
 export * from './net.common.ts';
 export declare enum MyProxy {
@@ -111,7 +111,9 @@ export declare function request(url: string | URL, options: RequestOptions): Pro
 /** 发起 http 请求并将响应体作为 json 解析 */
 export declare function request_json<T = any>(url: string | URL, options?: RequestOptions): Promise<T>;
 export interface ConnectOptions {
+    local_port?: number;
     timeout?: number;
+    on_timeout?: OnTimeout;
     print?: {
         error: boolean;
         connect: boolean;
@@ -119,12 +121,14 @@ export interface ConnectOptions {
 }
 /** 建立 tcp 连接，超时时间为 2 秒 (timeout 选项)，返回已连接的 socket
     连接中遇到的错误会 reject，之后取消监听 error 事件，由调用者 attach 处理
+    连接超时则自动 socket.resetAndDestroy
     - hostname: 要连接到的 ip 或域名
     - port: 要连接的端口
     - options?:
+        - local_port?: `随机端口` 使用的本地端口
         - timeout?: `2000` 超时时间
         - print?: 打印连接日志，错误日志
             - error?: `true`
             - connect: `false` */
-export declare function connect(hostname: string, port: number, { timeout: _timeout, print }?: ConnectOptions): Deferred2<net.Socket>;
+export declare function connect(hostname: string, port: number, { local_port, timeout: _timeout, on_timeout, print }?: ConnectOptions): Deferred2<net.Socket>;
 export declare function get_socket_ip(socket: net.Socket): string;

package/net.js

@@ -295,14 +295,16 @@ export async function request_json(url, options) {
 }
 /** 建立 tcp 连接，超时时间为 2 秒 (timeout 选项)，返回已连接的 socket
     连接中遇到的错误会 reject，之后取消监听 error 事件，由调用者 attach 处理
+    连接超时则自动 socket.resetAndDestroy
     - hostname: 要连接到的 ip 或域名
     - port: 要连接的端口
     - options?:
+        - local_port?: `随机端口` 使用的本地端口
         - timeout?: `2000` 超时时间
         - print?: 打印连接日志，错误日志
             - error?: `true`
             - connect: `false` */
-export function connect(hostname, port, { timeout: _timeout = 2000, print = { error: true, connect: false } } = {}) {
+export function connect(hostname, port, { local_port, timeout: _timeout = 2000, on_timeout, print = { error: true, connect: false } } = {}) {
     let pconnected = defer2();
     let timeouted = false;
     function get_message(message) {
@@ -311,6 +313,7 @@ export function connect(hostname, port, { timeout: _timeout = 2000, print = { er
     let socket = net.connect({
         host: hostname,
         port,
+        localPort: local_port,
         noDelay: true
     }, () => {
         if (pconnected.settled) {
@@ -341,11 +344,21 @@ export function connect(hostname, port, { timeout: _timeout = 2000, print = { er
         }
     };
     socket.once('error', on_error);
-    let timeout = setTimeout(() => {
+    let timeout = setTimeout(async () => {
         // 执行到这里一定没有 settled
         timeouted = true;
         socket.resetAndDestroy();
-        pconnected.reject(new TimeoutError(get_message('超时了')));
+        if (typeof on_timeout === 'function') {
+            pconnected.resolve(null);
+            try {
+                await on_timeout(new TimeoutError(get_message('超时了')));
+            }
+            catch (error) {
+                pconnected.reject(error);
+            }
+        }
+        else
+            pconnected.reject(new TimeoutError(on_timeout || get_message('超时了')));
     }, _timeout);
     return pconnected;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "xshell",
-    "version": "1.3.5",
+    "version": "1.3.6",
     "type": "module",
     "main": "./index.js",
     "bin": {

package/path.d.ts

@@ -54,7 +54,7 @@ export declare function extname(path: string): string;
 /** `/` */
 export declare const sep = "/";
 /** The platform-specific file delimiter. ';' or ':'. */
-export declare const delimiter: ";" | ":";
+export declare const delimiter: ":" | ";";
 /** Returns an object from a path string - the opposite of format().
     @param path path to evaluate.
     @throws {TypeError} if `path` is not a string. */
@@ -81,7 +81,7 @@ export declare let path: {
     basename: typeof basename;
     extname: typeof extname;
     sep: string;
-    delimiter: ";" | ":";
+    delimiter: ":" | ";";
     parse: typeof parse;
     format: typeof format;
     toNamespacedPath: typeof toNamespacedPath;

package/utils.common.d.ts

@@ -63,6 +63,7 @@ export declare function decode(buffer: Uint8Array): string;
 /** 比较两个 buffer 内容是否相同，第二个可以传入 string 自动编码转换后比较，
     高频调用时建议提前编码 right 并缓存 */
 export declare function buffer_equals(left: Uint8Array, right: Uint8Array | string): boolean;
+export type OnTimeout = string | ((error: TimeoutError) => void | Promise<void>);
 /** 在指定的时间 (milliseconds) 内运行某个任务，超时之后抛出错误或调用 on_timeout
     - milliseconds: 限时毫秒数
     - action?: 要等待运行的任务, async function 或 promise
@@ -74,7 +75,7 @@ export declare function buffer_equals(left: Uint8Array, right: Uint8Array | stri
                 - on_timeout 报错: timeout 函数最终抛出这个错误
         - 若不传: 直接抛出 TimeoutError
     - print?: `true` 打印已超时任务的错误 */
-export declare function timeout<TReturn>(milliseconds: number, action: Promise<TReturn> | (() => Promise<TReturn>), on_timeout?: string | ((error: TimeoutError) => void | Promise<void>), print?: boolean): Deferred2<TReturn>;
+export declare function timeout<TReturn>(milliseconds: number, action: Promise<TReturn> | (() => Promise<TReturn>), on_timeout?: OnTimeout, print?: boolean): Deferred2<TReturn>;
 /** 轮询尝试 action 共 times 次，每次间隔 duration
     action 返回 trusy 值时认为成功，返回 action 的结果
     如果次数用尽仍然失败，返回 null */