ms-types 0.1.23 → 0.1.25

package/types/http.d.ts

@@ -1,300 +1,300 @@
-/**
- * HTTP模块 包含发送HTTP请求、下载文件等功能、websocket等功能
- */
-declare namespace http {
-  /**
-   * 通用发送HTTP请求
-   * @param params 请求参数
-   * @returns 请求结果
-   * @example
-   * http.request({
-   *   url: "https://www.baidu.com",
-   *   method: "GET",
-   * })
-   */
-  function request(params: {
-    /**
-     * 请求地址
-     */
-    url: string;
-    /**
-     * 请求超时时间
-     */
-    timeout?: number;
-    /**
-     * 请求方法 GET POST PUT DELETE PATCH HEAD OPTIONS
-     */
-    method?: string;
-    /**
-     * 代理服务器
-     */
-    proxy?: {
-      /**
-       * 代理服务器地址
-       */
-      host: string;
-      /**
-       * 代理服务器端口
-       */
-      port: number;
-    };
-    /**
-     * 是否跟随重定向
-     */
-    followRedirects?: boolean;
-    /**
-     * 请求体 仅在POST方法下有效 json 需要进行JSON.stringify
-     */
-    requestBody?: string;
-    /**
-     * 请求头
-     */
-    userAgent?: string;
-    /**
-     * 是否忽略内容类型
-     */
-    ignoreContentType?: boolean;
-    /**
-     * 是否忽略HTTP错误
-     */
-    ignoreHttpErrors?: boolean;
-    /**
-     * 最大响应体大小 默认 10MB
-     */
-    maxBodySize?: number;
-    /**
-     * 引用来源
-     */
-    referrer?: string;
-    /**
-     * 请求头
-     */
-    header?: Record<string, string>;
-    /**
-     * Cookie
-     */
-    cookie?: Record<string, string>;
-    /**
-     * 请求参数
-     */
-    data?: Record<string, any>;
-    /**
-     * 请求文件
-     */
-    file?: Record<string, string>;
-    /**
-     * 响应字符集
-     */
-    responseCharset?: string;
-  }): {
-    /**
-     * 响应头
-     */
-    header: Record<string, string>;
-    /**
-     * 响应Cookie
-     */
-    cookie: Record<string, string>;
-    /**
-     * 响应状态码
-     */
-    statusCode: number;
-    /**
-     * 响应状态消息
-     */
-    statusMessage: string;
-    /**
-     * 响应字符集
-     */
-    charset: string;
-    /**
-     * 响应内容类型
-     */
-    contentType: string;
-    /**
-     * 响应体
-     */
-    body: string;
-  } | null;
-
-  /**
-   * 下载文件 支持断点续传
-   * @param url 请求地址
-   * @param file 文件路径
-   * @param timeout 超时时间
-   * @param headers 请求头
-   * @returns 下载是否成功
-   * @example
-   * http.downloadFile("https://www.baidu.com", "baidu.html")
-   */
-  function downloadFile(
-    url: string,
-    file: string,
-    timeout?: number,
-    headers?: Record<string, string>
-  ): boolean;
-
-  /**
-   * 发送GET请求
-   * @param url 请求地址
-   * @param params 请求参数
-   * @param timeout 超时时间
-   * @param headers 请求头
-   * @returns 请求结果
-   * @example
-   * http.httpGet("https://www.baidu.com")
-   */
-  function httpGet(
-    url: string,
-    params?: Record<string, string>,
-    timeout?: number,
-    headers?: Record<string, string>
-  ): string | null;
-
-  /**
-   * 发送POST请求
-   * @param url 请求地址
-   * @param params 请求参数
-   * @param files 请求文件
-   * @param timeout 超时时间
-   * @param headers 请求头
-   * @returns 请求结果
-   * @example
-   * http.httpPost("https://www.baidu.com")
-   */
-  function httpPost(
-    url: string,
-    params?: Record<string, string>,
-    files?: Record<string, string>,
-    timeout?: number,
-    headers?: Record<string, string>
-  ): string | null;
-
-  /**
-   * 发送JSON请求
-   * @param url 请求地址
-   * @param json 请求JSON数据
-   * @param timeout 超时时间
-   * @param headers 请求头
-   * @returns 请求结果
-   * @example
-   * http.postJSON("https://www.baidu.com", {
-   *   "name": "快点JS",
-   *   "version": "1.0.0"
-   * })
-   */
-  function postJSON(
-    url: string,
-    json?: Record<string, any>,
-    timeout?: number,
-    headers?: Record<string, string>
-  ): string | null;
-
-  /**
-   * 创建WebSocket连接
-   * @param url 连接地址
-   * @param header 连接头
-   * @returns WebSocket连接对象
-   * @example
-   * const ws = http.newWebsocket("ws://www.baidu.com")
-   * ws.connect()
-   * ws.onText((data) => {
-   *   logi(data)
-   * })
-   * ws.sendText("hello")
-   * ws.close()
-   */
-  function newWebsocket(
-    url: string,
-    header?: Record<string, string>
-  ): WebSocket;
-
-  /**
-   * WebSocket连接
-   */
-  interface WebSocket {
-    /**
-     * 连接WebSocket服务器
-     */
-    connect(): void;
-    /**
-     * 关闭WebSocket连接
-     */
-    close(): void;
-    /**
-     * 重置WebSocket连接
-     * @returns 重置是否成功
-     */
-    reset(): boolean;
-    /**
-     * 获取WebSocket是否已关闭
-     * @returns 是否已关闭
-     */
-    isClosed(): boolean;
-    /**
-     * 获取WebSocket是否已连接
-     * @returns 是否已连接
-     */
-    isConnected(): boolean;
-    /**
-     * 发送文本消息
-     * @param data 文本消息内容
-     */
-    sendText(data: string): void;
-    /**
-     * 发送二进制消息
-     * @param data 二进制消息内容
-     */
-    sendBinary(data: ArrayBuffer): void;
-    /**
-     * 设置打开回调
-     * @param callback 打开回调函数
-     */
-    onOpen(callback: () => void): void;
-    /**
-     * 设置关闭回调
-     * @param callback 关闭回调函数
-     */
-    onClose(callback: () => void): void;
-    /**
-     * 设置文本消息回调
-     * @param callback 文本消息回调函数
-     */
-    onText(callback: (data: string) => void): void;
-    /**
-     * 设置二进制消息回调
-     * @param callback 二进制消息回调函数
-     */
-    onBinary(callback: (data: ArrayBuffer) => void): void;
-    /**
-     * 设置错误回调
-     * @param callback 错误回调函数
-     */
-    onError(callback: (error: string) => void): void;
-    /**
-     * 设置连接超时时间
-     * @param timeout 超时时间，单位秒
-     */
-    setConnectionTimeout(timeout: number): void;
-    /**
-     * 设置写入超时时间
-     * @param timeout 超时时间，单位秒
-     */
-    setWriteTimeout(timeout: number): void;
-    /**
-     * 设置心跳间隔时间
-     * @param interval 间隔时间，单位秒
-     * @param callback 心跳回调函数
-     */
-    startHeartbeatInterval(interval: number, callback: () => string): void;
-    /**
-     * 停止心跳间隔
-     */
-    stopHeartbeatInterval(): void;
-    /**
-     * 设置自动重连
-     * @param autoReconnect 是否自动重连
-     */
-    setAutoReconnect(autoReconnect: boolean): void;
-  }
-}
+/**
+ * HTTP模块 包含发送HTTP请求、下载文件等功能、websocket等功能
+ */
+declare namespace http {
+  /**
+   * 通用发送HTTP请求
+   * @param params 请求参数
+   * @returns 请求结果
+   * @example
+   * http.request({
+   *   url: "https://www.baidu.com",
+   *   method: "GET",
+   * })
+   */
+  function request(params: {
+    /**
+     * 请求地址
+     */
+    url: string;
+    /**
+     * 请求超时时间
+     */
+    timeout?: number;
+    /**
+     * 请求方法 GET POST PUT DELETE PATCH HEAD OPTIONS
+     */
+    method?: string;
+    /**
+     * 代理服务器
+     */
+    proxy?: {
+      /**
+       * 代理服务器地址
+       */
+      host: string;
+      /**
+       * 代理服务器端口
+       */
+      port: number;
+    };
+    /**
+     * 是否跟随重定向
+     */
+    followRedirects?: boolean;
+    /**
+     * 请求体 仅在POST方法下有效 json 需要进行JSON.stringify
+     */
+    requestBody?: string;
+    /**
+     * 请求头
+     */
+    userAgent?: string;
+    /**
+     * 是否忽略内容类型
+     */
+    ignoreContentType?: boolean;
+    /**
+     * 是否忽略HTTP错误
+     */
+    ignoreHttpErrors?: boolean;
+    /**
+     * 最大响应体大小 默认 10MB
+     */
+    maxBodySize?: number;
+    /**
+     * 引用来源
+     */
+    referrer?: string;
+    /**
+     * 请求头
+     */
+    header?: Record<string, string>;
+    /**
+     * Cookie
+     */
+    cookie?: Record<string, string>;
+    /**
+     * 请求参数
+     */
+    data?: Record<string, any>;
+    /**
+     * 请求文件
+     */
+    file?: Record<string, string>;
+    /**
+     * 响应字符集
+     */
+    responseCharset?: string;
+  }): {
+    /**
+     * 响应头
+     */
+    header: Record<string, string>;
+    /**
+     * 响应Cookie
+     */
+    cookie: Record<string, string>;
+    /**
+     * 响应状态码
+     */
+    statusCode: number;
+    /**
+     * 响应状态消息
+     */
+    statusMessage: string;
+    /**
+     * 响应字符集
+     */
+    charset: string;
+    /**
+     * 响应内容类型
+     */
+    contentType: string;
+    /**
+     * 响应体
+     */
+    body: string;
+  } | null;
+
+  /**
+   * 下载文件 支持断点续传
+   * @param url 请求地址
+   * @param file 文件路径
+   * @param timeout 超时时间
+   * @param headers 请求头
+   * @returns 下载是否成功
+   * @example
+   * http.downloadFile("https://www.baidu.com", "baidu.html")
+   */
+  function downloadFile(
+    url: string,
+    file: string,
+    timeout?: number,
+    headers?: Record<string, string>
+  ): boolean;
+
+  /**
+   * 发送GET请求
+   * @param url 请求地址
+   * @param params 请求参数
+   * @param timeout 超时时间
+   * @param headers 请求头
+   * @returns 请求结果
+   * @example
+   * http.httpGet("https://www.baidu.com")
+   */
+  function httpGet(
+    url: string,
+    params?: Record<string, string>,
+    timeout?: number,
+    headers?: Record<string, string>
+  ): string | null;
+
+  /**
+   * 发送POST请求
+   * @param url 请求地址
+   * @param params 请求参数
+   * @param files 请求文件
+   * @param timeout 超时时间
+   * @param headers 请求头
+   * @returns 请求结果
+   * @example
+   * http.httpPost("https://www.baidu.com")
+   */
+  function httpPost(
+    url: string,
+    params?: Record<string, string>,
+    files?: Record<string, string>,
+    timeout?: number,
+    headers?: Record<string, string>
+  ): string | null;
+
+  /**
+   * 发送JSON请求
+   * @param url 请求地址
+   * @param json 请求JSON数据
+   * @param timeout 超时时间
+   * @param headers 请求头
+   * @returns 请求结果
+   * @example
+   * http.postJSON("https://www.baidu.com", {
+   *   "name": "快点JS",
+   *   "version": "1.0.0"
+   * })
+   */
+  function postJSON(
+    url: string,
+    json?: Record<string, any>,
+    timeout?: number,
+    headers?: Record<string, string>
+  ): string | null;
+
+  /**
+   * 创建WebSocket连接
+   * @param url 连接地址
+   * @param header 连接头
+   * @returns WebSocket连接对象
+   * @example
+   * const ws = http.newWebsocket("ws://www.baidu.com")
+   * ws.connect()
+   * ws.onText((data) => {
+   *   logi(data)
+   * })
+   * ws.sendText("hello")
+   * ws.close()
+   */
+  function newWebsocket(
+    url: string,
+    header?: Record<string, string>
+  ): WebSocket;
+
+  /**
+   * WebSocket连接
+   */
+  interface WebSocket {
+    /**
+     * 连接WebSocket服务器
+     */
+    connect(): void;
+    /**
+     * 关闭WebSocket连接
+     */
+    close(): void;
+    /**
+     * 重置WebSocket连接
+     * @returns 重置是否成功
+     */
+    reset(): boolean;
+    /**
+     * 获取WebSocket是否已关闭
+     * @returns 是否已关闭
+     */
+    isClosed(): boolean;
+    /**
+     * 获取WebSocket是否已连接
+     * @returns 是否已连接
+     */
+    isConnected(): boolean;
+    /**
+     * 发送文本消息
+     * @param data 文本消息内容
+     */
+    sendText(data: string): void;
+    /**
+     * 发送二进制消息
+     * @param data 二进制消息内容
+     */
+    sendBinary(data: ArrayBuffer): void;
+    /**
+     * 设置打开回调
+     * @param callback 打开回调函数
+     */
+    onOpen(callback: () => void): void;
+    /**
+     * 设置关闭回调
+     * @param callback 关闭回调函数
+     */
+    onClose(callback: () => void): void;
+    /**
+     * 设置文本消息回调
+     * @param callback 文本消息回调函数
+     */
+    onText(callback: (data: string) => void): void;
+    /**
+     * 设置二进制消息回调
+     * @param callback 二进制消息回调函数
+     */
+    onBinary(callback: (data: ArrayBuffer) => void): void;
+    /**
+     * 设置错误回调
+     * @param callback 错误回调函数
+     */
+    onError(callback: (error: string) => void): void;
+    /**
+     * 设置连接超时时间
+     * @param timeout 超时时间，单位秒
+     */
+    setConnectionTimeout(timeout: number): void;
+    /**
+     * 设置写入超时时间
+     * @param timeout 超时时间，单位秒
+     */
+    setWriteTimeout(timeout: number): void;
+    /**
+     * 设置心跳间隔时间
+     * @param interval 间隔时间，单位秒
+     * @param callback 心跳回调函数
+     */
+    startHeartbeatInterval(interval: number, callback: () => string): void;
+    /**
+     * 停止心跳间隔
+     */
+    stopHeartbeatInterval(): void;
+    /**
+     * 设置自动重连
+     * @param autoReconnect 是否自动重连
+     */
+    setAutoReconnect(autoReconnect: boolean): void;
+  }
+}