docs: update

vbenjs · Jan 21, 2025 · c001d54 · c001d54
1 parent 44d008e
commit c001d54
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/packages/effects/request/src/request-client/modules/downloader.ts b/packages/effects/request/src/request-client/modules/downloader.ts
@@ -1,5 +1,5 @@
 import type { RequestClient } from '../request-client';
-import type { RequestClientConfig, RequestResponse } from '../types';
+import type { RequestClientConfig } from '../types';
 
 type DownloadRequestConfig = {
   /**
@@ -20,9 +20,9 @@ class FileDownloader {
    * 下载文件
    * @param url 文件的完整链接
    * @param config 配置信息，可选。
-   * @returns 如果config.responseReturn为'body'，则返回Blob(默认)，否则返回AxiosResponse<Blob>
+   * @returns 如果config.responseReturn为'body'，则返回Blob(默认)，否则返回RequestResponse<Blob>
    */
-  public async download<T = RequestResponse<Blob>>(
+  public async download<T = Blob>(
     url: string,
     config?: DownloadRequestConfig,
   ): Promise<T> {

diff --git a/packages/effects/request/src/request-client/types.ts b/packages/effects/request/src/request-client/types.ts
@@ -8,7 +8,7 @@ import type {
 type ExtendOptions = {
   /** 响应数据的返回方式。
    * raw: 原始的AxiosResponse，包括headers、status等，不做是否成功请求的检查。
-   * body: 返回响应数据的BODY部分（只会根据status检查请求是否成功，忽略对code的判断）。
+   * body: 返回响应数据的BODY部分（只会根据status检查请求是否成功，忽略对code的判断，这种情况下应由调用方检查请求是否成功）。
    * data: 解构响应的BODY数据，只返回其中的data节点数据（会检查status和code是否为成功状态）。
    */
   responseReturn?: 'body' | 'data' | 'raw';