ms-types 0.1.23 → 0.1.26

package/types/zh/HTTP/346/250/241/345/235/227.d.ts

@@ -1,301 +1,301 @@
-/// <reference path="全局模块.d.ts" />
-/**
- * HTTP模块 包含发送HTTP请求、下载文件等功能、websocket等功能
- */
-declare namespace $HTTP {
-  /**
-   * 通用发送HTTP请求
-   * @param params 请求参数
-   * @returns 请求结果
-   * @example
-   * $HTTP.发送请求({
-   *   url: "https://www.baidu.com",
-   *   method: "GET",
-   * })
-   */
-  function 发送请求(params: {
-    /**
-     * 请求地址
-     */
-    url: 字符串;
-    /**
-     * 请求超时时间
-     */
-    timeout?: 数字;
-    /**
-     * 请求方法 GET POST PUT DELETE PATCH HEAD OPTIONS
-     */
-    method?: 字符串;
-    /**
-     * 代理服务器
-     */
-    proxy?: {
-      /**
-       * 代理服务器地址
-       */
-      host: 字符串;
-      /**
-       * 代理服务器端口
-       */
-      port: 数字;
-    };
-    /**
-     * 是否跟随重定向
-     */
-    followRedirects?: 布尔值;
-    /**
-     * 请求体 仅在POST方法下有效 json 需要进行JSON.stringify
-     */
-    requestBody?: 字符串;
-    /**
-     * 请求头
-     */
-    userAgent?: 字符串;
-    /**
-     * 是否忽略内容类型
-     */
-    ignoreContentType?: 布尔值;
-    /**
-     * 是否忽略HTTP错误
-     */
-    ignoreHttpErrors?: 布尔值;
-    /**
-     * 最大响应体大小 默认 10MB
-     */
-    maxBodySize?: 数字;
-    /**
-     * 引用来源
-     */
-    referrer?: 字符串;
-    /**
-     * 请求头
-     */
-    header?: 字典<字符串>;
-    /**
-     * Cookie
-     */
-    cookie?: 字典<字符串>;
-    /**
-     * 请求参数
-     */
-    data?: 字典<任意类型>;
-    /**
-     * 请求文件
-     */
-    file?: 字典<字符串>;
-    /**
-     * 响应字符集
-     */
-    responseCharset?: 字符串;
-  }): {
-    /**
-     * 响应头
-     */
-    header: 字典<字符串>;
-    /**
-     * 响应Cookie
-     */
-    cookie: 字典<字符串>;
-    /**
-     * 响应状态码
-     */
-    statusCode: 数字;
-    /**
-     * 响应状态消息
-     */
-    statusMessage: 字符串;
-    /**
-     * 响应字符集
-     */
-    charset: 字符串;
-    /**
-     * 响应内容类型
-     */
-    contentType: 字符串;
-    /**
-     * 响应体
-     */
-    body: 字符串;
-  } | null;
-
-  /**
-   * 下载文件 支持断点续传
-   * @param 请求地址
-   * @param 保存的文件路径
-   * @param 超时时间
-   * @param 请求头
-   * @returns 下载是否成功
-   * @example
-   * $HTTP.下载文件("https://www.baidu.com", "baidu.html")
-   */
-  function 下载文件(
-    请求地址: 字符串,
-    保存的文件路径: 字符串,
-    超时时间?: 数字,
-    请求头?: 字典<字符串>
-  ): 布尔值;
-
-  /**
-   * 发送GET请求
-   * @param 请求地址
-   * @param 请求参数
-   * @param 超时时间
-   * @param 请求头
-   * @returns 请求结果
-   * @example
-   * $HTTP.发送GET请求("https://www.baidu.com")
-   */
-  function 发送GET请求(
-    请求地址: 字符串,
-    请求参数?: 字典<字符串>,
-    超时时间?: 数字,
-    请求头?: 字典<字符串>
-  ): 字符串 | null;
-
-  /**
-   * 发送POST请求
-   * @param 请求地址
-   * @param 请求参数
-   * @param 请求文件
-   * @param 超时时间
-   * @param 请求头
-   * @returns 请求结果
-   * @example
-   * $HTTP.发送POST请求("https://www.baidu.com")
-   */
-  function 发送POST请求(
-    请求地址: 字符串,
-    请求参数?: 字典<任意类型>,
-    请求文件?: 字典<字符串>,
-    超时时间?: 数字,
-    请求头?: 字典<字符串>
-  ): 字符串 | null;
-
-  /**
-   * 发送JSON请求
-   * @param 请求地址
-   * @param 请求JSON数据
-   * @param 超时时间
-   * @param 请求头
-   * @returns 请求结果
-   * @example
-   * $HTTP.发送JSON请求("https://www.baidu.com", {
-   *   "name": "快点JS",
-   *   "version": "1.0.0"
-   * })
-   */
-  function 发送JSON请求(
-    请求地址: 字符串,
-    请求JSON数据?: 字典<任意类型>,
-    超时时间?: 数字,
-    请求头?: 字典<字符串>
-  ): 字符串 | null;
-
-  /**
-   * 创建WebSocket连接
-   * @param 连接地址
-   * @param 连接头
-   * @returns WebSocket连接对象
-   * @example
-   * const ws连接 = $HTTP.创建WebSocket连接("ws://www.baidu.com")
-   * ws连接.连接()
-   * ws连接.监听文本消息回调((data) => {
-   *   $打印信息日志(data)
-   * })
-   * ws连接.发送文本("hello")
-   * ws连接.关闭()
-   */
-  function 创建WebSocket连接(
-    连接地址: 字符串,
-    连接头?: 字典<字符串>
-  ): WebSocket连接;
-
-  /**
-   * WebSocket连接
-   */
-  interface WebSocket连接 {
-    /**
-     * 连接WebSocket服务器
-     */
-    连接(): 无返回值;
-    /**
-     * 关闭WebSocket连接
-     */
-    关闭(): 无返回值;
-    /**
-     * 重置WebSocket连接
-     * @returns 重置是否成功
-     */
-    重置(): 布尔值;
-    /**
-     * 获取WebSocket是否已关闭
-     * @returns 是否已关闭
-     */
-    是否已关闭(): 布尔值;
-    /**
-     * 获取WebSocket是否已连接
-     * @returns 是否已连接
-     */
-    是否已连接(): 布尔值;
-    /**
-     * 发送文本消息
-     * @param 数据 文本消息内容
-     */
-    发送文本(数据: 字符串): 无返回值;
-    /**
-     * 发送二进制消息
-     * @param 数据 二进制消息内容
-     */
-    发送二进制(数据: ArrayBuffer): 无返回值;
-    /**
-     * 设置打开回调
-     * @param 回调 打开回调函数
-     */
-    监听打开回调(回调: () => 无返回值): 无返回值;
-    /**
-     * 设置关闭回调
-     * @param 回调 关闭回调函数
-     */
-    监听关闭回调(回调: () => 无返回值): 无返回值;
-    /**
-     * 设置文本消息回调
-     * @param 回调 文本消息回调函数
-     */
-    监听文本消息回调(回调: (数据: 字符串) => 无返回值): 无返回值;
-    /**
-     * 设置二进制消息回调
-     * @param 回调 二进制消息回调函数
-     */
-    监听二进制消息回调(回调: (数据: ArrayBuffer) => 无返回值): 无返回值;
-    /**
-     * 设置错误回调
-     * @param 回调 错误回调函数
-     */
-    监听异常回调(回调: (异常信息: 字符串) => 无返回值): 无返回值;
-    /**
-     * 设置连接超时时间
-     * @param 超时时间，单位秒
-     */
-    设置连接超时时间(超时时间: 数字): 无返回值;
-    /**
-     * 设置写入超时时间
-     * @param 超时时间，单位秒
-     */
-    设置写入超时时间(超时时间: 数字): 无返回值;
-    /**
-     * 设置心跳间隔时间
-     * @param 间隔时间，单位秒
-     * @param 心跳回调函数
-     */
-    启动心跳间隔(间隔时间: 数字, 回调: () => 字符串): 无返回值;
-    /**
-     * 停止心跳间隔
-     */
-    停止心跳间隔(): 无返回值;
-    /**
-     * 设置自动重连
-     * @param 是否自动重连
-     */
-    设置自动重连(是否自动重连: 布尔值): 无返回值;
-  }
-}
+/// <reference path="全局模块.d.ts" />
+/**
+ * HTTP模块 包含发送HTTP请求、下载文件等功能、websocket等功能
+ */
+declare namespace $HTTP {
+  /**
+   * 通用发送HTTP请求
+   * @param params 请求参数
+   * @returns 请求结果
+   * @example
+   * $HTTP.发送请求({
+   *   url: "https://www.baidu.com",
+   *   method: "GET",
+   * })
+   */
+  function 发送请求(params: {
+    /**
+     * 请求地址
+     */
+    url: 字符串;
+    /**
+     * 请求超时时间
+     */
+    timeout?: 数字;
+    /**
+     * 请求方法 GET POST PUT DELETE PATCH HEAD OPTIONS
+     */
+    method?: 字符串;
+    /**
+     * 代理服务器
+     */
+    proxy?: {
+      /**
+       * 代理服务器地址
+       */
+      host: 字符串;
+      /**
+       * 代理服务器端口
+       */
+      port: 数字;
+    };
+    /**
+     * 是否跟随重定向
+     */
+    followRedirects?: 布尔值;
+    /**
+     * 请求体 仅在POST方法下有效 json 需要进行JSON.stringify
+     */
+    requestBody?: 字符串;
+    /**
+     * 请求头
+     */
+    userAgent?: 字符串;
+    /**
+     * 是否忽略内容类型
+     */
+    ignoreContentType?: 布尔值;
+    /**
+     * 是否忽略HTTP错误
+     */
+    ignoreHttpErrors?: 布尔值;
+    /**
+     * 最大响应体大小 默认 10MB
+     */
+    maxBodySize?: 数字;
+    /**
+     * 引用来源
+     */
+    referrer?: 字符串;
+    /**
+     * 请求头
+     */
+    header?: 字典<字符串>;
+    /**
+     * Cookie
+     */
+    cookie?: 字典<字符串>;
+    /**
+     * 请求参数
+     */
+    data?: 字典<任意类型>;
+    /**
+     * 请求文件
+     */
+    file?: 字典<字符串>;
+    /**
+     * 响应字符集
+     */
+    responseCharset?: 字符串;
+  }): {
+    /**
+     * 响应头
+     */
+    header: 字典<字符串>;
+    /**
+     * 响应Cookie
+     */
+    cookie: 字典<字符串>;
+    /**
+     * 响应状态码
+     */
+    statusCode: 数字;
+    /**
+     * 响应状态消息
+     */
+    statusMessage: 字符串;
+    /**
+     * 响应字符集
+     */
+    charset: 字符串;
+    /**
+     * 响应内容类型
+     */
+    contentType: 字符串;
+    /**
+     * 响应体
+     */
+    body: 字符串;
+  } | null;
+
+  /**
+   * 下载文件 支持断点续传
+   * @param 请求地址
+   * @param 保存的文件路径
+   * @param 超时时间
+   * @param 请求头
+   * @returns 下载是否成功
+   * @example
+   * $HTTP.下载文件("https://www.baidu.com", "baidu.html")
+   */
+  function 下载文件(
+    请求地址: 字符串,
+    保存的文件路径: 字符串,
+    超时时间?: 数字,
+    请求头?: 字典<字符串>
+  ): 布尔值;
+
+  /**
+   * 发送GET请求
+   * @param 请求地址
+   * @param 请求参数
+   * @param 超时时间
+   * @param 请求头
+   * @returns 请求结果
+   * @example
+   * $HTTP.发送GET请求("https://www.baidu.com")
+   */
+  function 发送GET请求(
+    请求地址: 字符串,
+    请求参数?: 字典<字符串>,
+    超时时间?: 数字,
+    请求头?: 字典<字符串>
+  ): 字符串 | null;
+
+  /**
+   * 发送POST请求
+   * @param 请求地址
+   * @param 请求参数
+   * @param 请求文件
+   * @param 超时时间
+   * @param 请求头
+   * @returns 请求结果
+   * @example
+   * $HTTP.发送POST请求("https://www.baidu.com")
+   */
+  function 发送POST请求(
+    请求地址: 字符串,
+    请求参数?: 字典<任意类型>,
+    请求文件?: 字典<字符串>,
+    超时时间?: 数字,
+    请求头?: 字典<字符串>
+  ): 字符串 | null;
+
+  /**
+   * 发送JSON请求
+   * @param 请求地址
+   * @param 请求JSON数据
+   * @param 超时时间
+   * @param 请求头
+   * @returns 请求结果
+   * @example
+   * $HTTP.发送JSON请求("https://www.baidu.com", {
+   *   "name": "快点JS",
+   *   "version": "1.0.0"
+   * })
+   */
+  function 发送JSON请求(
+    请求地址: 字符串,
+    请求JSON数据?: 字典<任意类型>,
+    超时时间?: 数字,
+    请求头?: 字典<字符串>
+  ): 字符串 | null;
+
+  /**
+   * 创建WebSocket连接
+   * @param 连接地址
+   * @param 连接头
+   * @returns WebSocket连接对象
+   * @example
+   * const ws连接 = $HTTP.创建WebSocket连接("ws://www.baidu.com")
+   * ws连接.连接()
+   * ws连接.监听文本消息回调((data) => {
+   *   $打印信息日志(data)
+   * })
+   * ws连接.发送文本("hello")
+   * ws连接.关闭()
+   */
+  function 创建WebSocket连接(
+    连接地址: 字符串,
+    连接头?: 字典<字符串>
+  ): WebSocket连接;
+
+  /**
+   * WebSocket连接
+   */
+  interface WebSocket连接 {
+    /**
+     * 连接WebSocket服务器
+     */
+    连接(): 无返回值;
+    /**
+     * 关闭WebSocket连接
+     */
+    关闭(): 无返回值;
+    /**
+     * 重置WebSocket连接
+     * @returns 重置是否成功
+     */
+    重置(): 布尔值;
+    /**
+     * 获取WebSocket是否已关闭
+     * @returns 是否已关闭
+     */
+    是否已关闭(): 布尔值;
+    /**
+     * 获取WebSocket是否已连接
+     * @returns 是否已连接
+     */
+    是否已连接(): 布尔值;
+    /**
+     * 发送文本消息
+     * @param 数据 文本消息内容
+     */
+    发送文本(数据: 字符串): 无返回值;
+    /**
+     * 发送二进制消息
+     * @param 数据 二进制消息内容
+     */
+    发送二进制(数据: ArrayBuffer): 无返回值;
+    /**
+     * 设置打开回调
+     * @param 回调 打开回调函数
+     */
+    监听打开回调(回调: () => 无返回值): 无返回值;
+    /**
+     * 设置关闭回调
+     * @param 回调 关闭回调函数
+     */
+    监听关闭回调(回调: () => 无返回值): 无返回值;
+    /**
+     * 设置文本消息回调
+     * @param 回调 文本消息回调函数
+     */
+    监听文本消息回调(回调: (数据: 字符串) => 无返回值): 无返回值;
+    /**
+     * 设置二进制消息回调
+     * @param 回调 二进制消息回调函数
+     */
+    监听二进制消息回调(回调: (数据: ArrayBuffer) => 无返回值): 无返回值;
+    /**
+     * 设置错误回调
+     * @param 回调 错误回调函数
+     */
+    监听异常回调(回调: (异常信息: 字符串) => 无返回值): 无返回值;
+    /**
+     * 设置连接超时时间
+     * @param 超时时间，单位秒
+     */
+    设置连接超时时间(超时时间: 数字): 无返回值;
+    /**
+     * 设置写入超时时间
+     * @param 超时时间，单位秒
+     */
+    设置写入超时时间(超时时间: 数字): 无返回值;
+    /**
+     * 设置心跳间隔时间
+     * @param 间隔时间，单位秒
+     * @param 心跳回调函数
+     */
+    启动心跳间隔(间隔时间: 数字, 回调: () => 字符串): 无返回值;
+    /**
+     * 停止心跳间隔
+     */
+    停止心跳间隔(): 无返回值;
+    /**
+     * 设置自动重连
+     * @param 是否自动重连
+     */
+    设置自动重连(是否自动重连: 布尔值): 无返回值;
+  }
+}