@czf0613/http_client 0.0.2 → 0.1.0

package/dist/http_client.d.ts

@@ -14,6 +14,7 @@ type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD';
  * @param queryParams 查询参数，会被自动拼接到url中（会自动进行转义）
  * @param customHeaders 自定义请求头，不需要写content-type这种会被自动处理的头
  * @param body 请求体，适用于POST/PUT请求，传入字符串、数字会被处理成text/plain，传入对象会被处理成application/json，传入FormData会被处理成multipart/form-data，目前不建议直接发送二进制对象
+ * @param timeoutMs 超时时间，单位毫秒，默认5秒。这个超时的时间指的是发出请求，到接收到请求头的时间，不包含读取请求体的时间。如果需要控制读取请求体的超时，请自行用Promise.race实现。
  * @returns 返回Fetch API的Response对象
  */
 export declare function makeHttpRequest(url: string, method?: HttpMethod, queryParams?: Record<string, string | number> | null, customHeaders?: Record<string, string> | null, body?: any | null, timeoutMs?: number): Promise<Response>;
@@ -23,7 +24,9 @@ export declare function makeHttpRequest(url: string, method?: HttpMethod, queryP
  * 目前这个接口只支持处理后端不停发送data: xxx\n\n这种格式的响应
  * 默认不抛出异常，会在生成器的返回值里面指明成功还是失败
  * @see makeHttpRequest 这里的参数说明
+ * @param connectTimeoutMs 连接超时时间，单位毫秒，默认30秒
+ * @param messageTimeoutMs 每条消息超时时间，单位毫秒，默认30秒
  * @returns 返回一个异步生成器，每次迭代返回一个字符串（流式响应）
  */
-export declare function makeSSERequest(url: string, method?: HttpMethod, queryParams?: Record<string, string | number> | null, customHeaders?: Record<string, string> | null, body?: any | null): AsyncGenerator<string, boolean, undefined>;
+export declare function makeSSERequest(url: string, method?: HttpMethod, queryParams?: Record<string, string | number> | null, customHeaders?: Record<string, string> | null, body?: any | null, connectTimeoutMs?: number, messageTimeoutMs?: number): AsyncGenerator<string, boolean, undefined>;
 export {};

package/dist/http_client.js

@@ -1,3 +1,4 @@
+import { sleep, TIMEOUT_MARKER } from './timer';
 /**
  * 拼接URL和查询参数，会自动处理转义
  * @param url 基础URL，不要带任何查询参数
@@ -29,6 +30,7 @@ const DEFAULT_TIMEOUT = 5000;
  * @param queryParams 查询参数，会被自动拼接到url中（会自动进行转义）
  * @param customHeaders 自定义请求头，不需要写content-type这种会被自动处理的头
  * @param body 请求体，适用于POST/PUT请求，传入字符串、数字会被处理成text/plain，传入对象会被处理成application/json，传入FormData会被处理成multipart/form-data，目前不建议直接发送二进制对象
+ * @param timeoutMs 超时时间，单位毫秒，默认5秒。这个超时的时间指的是发出请求，到接收到请求头的时间，不包含读取请求体的时间。如果需要控制读取请求体的超时，请自行用Promise.race实现。
  * @returns 返回Fetch API的Response对象
  */
 export async function makeHttpRequest(url, method = 'GET', queryParams = null, customHeaders = null, body = null, timeoutMs = DEFAULT_TIMEOUT) {
@@ -44,7 +46,9 @@ export async function makeHttpRequest(url, method = 'GET', queryParams = null, c
         // 无body时，不设置Content-Type
     }
     else if (body instanceof FormData) {
-        // 使用FormData时，浏览器会自动设置Content-Type和boundary，不要多手
+        // 使用FormData时，浏览器会自动设置Content-Type和boundary，不要多手，有我也得给你删了
+        delete customHeaders['Content-Type'];
+        delete customHeaders['content-type'];
     }
     else if (typeof body === 'string') {
         customHeaders['Content-Type'] = 'text/plain';
@@ -75,11 +79,13 @@ export async function makeHttpRequest(url, method = 'GET', queryParams = null, c
  * 目前这个接口只支持处理后端不停发送data: xxx\n\n这种格式的响应
  * 默认不抛出异常，会在生成器的返回值里面指明成功还是失败
  * @see makeHttpRequest 这里的参数说明
+ * @param connectTimeoutMs 连接超时时间，单位毫秒，默认30秒
+ * @param messageTimeoutMs 每条消息超时时间，单位毫秒，默认30秒
  * @returns 返回一个异步生成器，每次迭代返回一个字符串（流式响应）
  */
-export async function* makeSSERequest(url, method = 'GET', queryParams = null, customHeaders = null, body = null) {
+export async function* makeSSERequest(url, method = 'GET', queryParams = null, customHeaders = null, body = null, connectTimeoutMs = 30000, messageTimeoutMs = 30000) {
     var _a;
-    const resp = await makeHttpRequest(url, method, queryParams, customHeaders, body, 30000);
+    const resp = await makeHttpRequest(url, method, queryParams, customHeaders, body, connectTimeoutMs);
     if (!resp.ok) {
         return false;
     }
@@ -90,7 +96,15 @@ export async function* makeSSERequest(url, method = 'GET', queryParams = null, c
     let buffer = new Uint8Array(0);
     try {
         while (true) {
-            const { done, value } = await reader.read();
+            const raceResult = await Promise.race([
+                sleep(messageTimeoutMs),
+                reader.read(),
+            ]);
+            // 如果timeout先完成，说明超时了
+            if (raceResult === TIMEOUT_MARKER) {
+                throw new Error('SSE message timeout');
+            }
+            const { done, value } = raceResult;
             if (done || !value) {
                 break;
             }

package/dist/timer.d.ts

@@ -0,0 +1,2 @@
+export declare const TIMEOUT_MARKER: unique symbol;
+export declare function sleep(ms: number): Promise<typeof TIMEOUT_MARKER>;

package/dist/timer.js

@@ -0,0 +1,4 @@
+export const TIMEOUT_MARKER = Symbol('timeout');
+export function sleep(ms) {
+    return new Promise(resolve => setTimeout(() => resolve(TIMEOUT_MARKER), ms));
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@czf0613/http_client",
   "private": false,
-  "version": "0.0.2",
+  "version": "0.1.0",
   "description": "Simple http client with fetch, supporting modified SSE protocol",
   "keywords": [
     "http client",