feat: support more request options, omit request/upload/download config nullish value

Author: ModyQyW

README.md

@@ -377,6 +377,21 @@ const instance = un.create({
   // 默认值是 'text'
   responseType: 'text',
 
+  // request 使用
+  // 是否验证 ssl 证书
+  // 默认值是 true
+  sslVerify: true,
+
+  // request 使用
+  // 跨域请求时是否需要使用凭证
+  // 默认值是 false
+  withCredentials: false,
+
+  // request 使用
+  // 是否在 DNS 解析时优先使用 ipv4
+  // 默认值是 false
+  firstIpv4: false,
+
   // request 使用
   // 是否开启 http2
   // 默认值是 false
@@ -411,26 +426,33 @@ const instance = un.create({
   // 默认值是 false
   forceCellularNetwork: false,
 
-  // request 使用
-  // 是否验证 ssl 证书
-  // 默认值是 true
-  sslVerify: true,
-
-  // request 使用
-  // 跨域请求时是否需要使用凭证
-  // 默认值是 false
-  withCredentials: false,
-
-  // request 使用
-  // 是否在 DNS 解析时优先使用 ipv4
-  // 默认值是 false
-  firstIpv4: false,
-
   // request 使用
   // 监听 Transfer-Encoding Chunk Received 事件
   // 当接收到新的 chunk 时触发
   onChunkReceived?: (response) => { /* ... */ },
 
+  // Request 使用
+  // 是否可在 headers 中编辑 cookie
+  // 默认为 false
+  enableCookie?: boolean;
+
+  // Request 使用
+  // 是否开启云加速
+  // 默认为 false
+  cloudCache?: boolean | {
+    // 用于指定 query 中哪些字段不作为缓存依据
+    excludeURLQueries?: string[];
+    // 用于表达云加速缓存的最快刷新时间
+    // 单位 s
+    minRefresh?: number;
+    [key: string]: any;
+  };
+
+  // Request 使用
+  // 控制当前请求是否延时至首屏内容渲染后发送
+  // 默认为 false
+  defer?: boolean;
+
   // upload 使用
   // 需要上传的文件列表，files 和 filePath 必填一个
   // 使用该参数时，filePath 和 name 无效

docs/api/request-config.md

@@ -104,6 +104,21 @@
   // 默认值是 'text'
   responseType: "text",
 
+  // request 使用
+  // 是否验证 ssl 证书
+  // 默认值是 true
+  sslVerify: true,
+
+  // request 使用
+  // 跨域请求时是否需要使用凭证
+  // 默认值是 false
+  withCredentials: false,
+
+  // request 使用
+  // 是否在 DNS 解析时优先使用 ipv4
+  // 默认值是 false
+  firstIpv4: false,
+
   // request 使用
   // 是否开启 http2
   // 默认值是 false
@@ -138,28 +153,35 @@
   // 默认值是 false
   forceCellularNetwork: false,
 
-  // request 使用
-  // 是否验证 ssl 证书
-  // 默认值是 true
-  sslVerify: true,
-
-  // request 使用
-  // 跨域请求时是否需要使用凭证
-  // 默认值是 false
-  withCredentials: false,
-
-  // request 使用
-  // 是否在 DNS 解析时优先使用 ipv4
-  // 默认值是 false
-  firstIpv4: false,
-
   // request 使用
   // 监听 Transfer-Encoding Chunk Received 事件
   // 当接收到新的 chunk 时触发
   onChunkReceived: (response) => {
     /* ... */
   },
 
+  // Request 使用
+  // 是否可在 headers 中编辑 cookie
+  // 默认为 false
+  enableCookie?: boolean;
+
+  // Request 使用
+  // 是否开启云加速
+  // 默认为 false
+  cloudCache?: boolean | {
+    // 用于指定 query 中哪些字段不作为缓存依据
+    excludeURLQueries?: string[];
+    // 用于表达云加速缓存的最快刷新时间
+    // 单位 s
+    minRefresh?: number;
+    [key: string]: any;
+  };
+
+  // Request 使用
+  // 控制当前请求是否延时至首屏内容渲染后发送
+  // 默认为 false
+  defer?: boolean;
+
   // upload 使用
   // 需要上传的文件列表，files 和 filePath 必填一个
   // 使用该参数时，filePath 和 name 无效

packages/core/src/types/config.ts

@@ -126,6 +126,30 @@ export interface UnConfig<T = UnData, D = UnData> {
    * 默认为 text
    */
   responseType?: UnResponseType;
+  /**
+   * Request 使用
+   *
+   * 是否验证 ssl 证书
+   *
+   * 默认为 true
+   */
+  sslVerify?: boolean;
+  /**
+   * Request 使用
+   *
+   * 跨域请求时是否需要使用凭证
+   *
+   * 默认为 false
+   */
+  withCredentials?: boolean;
+  /**
+   * Request 使用
+   *
+   * 是否在 DNS 解析时优先使用 ipv4
+   *
+   * 默认为 false
+   */
+  firstIpv4?: boolean;
   /**
    * Request 使用
    *
@@ -183,27 +207,42 @@ export interface UnConfig<T = UnData, D = UnData> {
   /**
    * Request 使用
    *
-   * 是否验证 ssl 证书
+   * 是否可在 headers 中编辑 cookie
    *
-   * 默认为 true
+   * 默认为 false
    */
-  sslVerify?: boolean;
+  enableCookie?: boolean;
   /**
    * Request 使用
    *
-   * 跨域请求时是否需要使用凭证
+   * 是否开启云加速
    *
    * 默认为 false
    */
-  withCredentials?: boolean;
+  cloudCache?:
+    | boolean
+    | {
+        /**
+         * 用于指定 query 中哪些字段不作为缓存依据
+         */
+        excludeURLQueries?: string[];
+        /**
+         * 用于表达云加速缓存的最快刷新时间
+         *
+         * 单位 s
+         */
+        minRefresh?: number;
+        [key: string]: any;
+      };
   /**
    * Request 使用
    *
-   * 是否在 DNS 解析时优先使用 ipv4
+   * 控制当前请求是否延时至首屏内容渲染后发送
    *
    * 默认为 false
    */
-  firstIpv4?: boolean;
+  defer?: boolean;
+
   /**
    * Request 使用
    *

packages/core/src/utils/buildDownloadConfig.ts

@@ -4,8 +4,8 @@ import { buildUrl } from "./buildUrl";
 
 export const buildDownloadConfig = <T = UnData, D = UnData>(
   config: UnConfig<T, D>,
-) =>
-  ({
+): UniApp.DownloadFileOption => {
+  const result = {
     url: buildUrl(
       buildFullPath(
         config.baseUrl ?? "",
@@ -18,4 +18,13 @@ export const buildDownloadConfig = <T = UnData, D = UnData>(
     header: config.headers,
     timeout: config.timeout,
     filePath: config.filePath,
-  }) as UniApp.DownloadFileOption;
+  };
+
+  const entries = Object.entries(result) as [
+    keyof typeof result,
+    (typeof result)[keyof typeof result],
+  ][];
+  return Object.fromEntries(
+    entries.filter(([k]) => result[k] != null),
+  ) as unknown as UniApp.DownloadFileOption;
+};

packages/core/src/utils/buildRequestConfig.ts

@@ -4,8 +4,8 @@ import { buildUrl } from "./buildUrl";
 
 export const buildRequestConfig = <T = UnData, D = UnData>(
   config: UnConfig<T, D>,
-) =>
-  ({
+): UniApp.RequestOptions => {
+  const result = {
     url: buildUrl(
       buildFullPath(
         config.baseUrl ?? "",
@@ -21,14 +21,26 @@ export const buildRequestConfig = <T = UnData, D = UnData>(
     timeout: config.timeout,
     dataType: config.dataType,
     responseType: config.responseType,
+    sslVerify: config.sslVerify,
+    withCredentials: config.withCredentials,
+    firstIpv4: config.firstIpv4,
     enableHttp2: config.enableHttp2,
     enableQuic: config.enableQuic,
     enableCache: config.enableCache,
     enableHttpDNS: config.enableHttpDNS,
     httpDNSServiceId: config.httpDNSServiceId,
     enableChunked: config.enableChunked,
     forceCellularNetwork: config.forceCellularNetwork,
-    sslVerify: config.sslVerify,
-    withCredentials: config.withCredentials,
-    firstIpv4: config.firstIpv4,
-  }) as UniApp.RequestOptions;
+    enableCookie: config.enableCookie,
+    cloudCache: config.cloudCache,
+    defer: config.defer,
+  };
+
+  const entries = Object.entries(result) as [
+    keyof typeof result,
+    (typeof result)[keyof typeof result],
+  ][];
+  return Object.fromEntries(
+    entries.filter(([k]) => result[k] != null),
+  ) as unknown as UniApp.RequestOptions;
+};

packages/core/src/utils/buildUploadConfig.ts

@@ -4,8 +4,8 @@ import { buildUrl } from "./buildUrl";
 
 export const buildUploadConfig = <T = UnData, D = UnData>(
   config: UnConfig<T, D>,
-) =>
-  ({
+): UniApp.UploadFileOption => {
+  const result = {
     url: buildUrl(
       buildFullPath(
         config.baseUrl ?? "",
@@ -23,4 +23,13 @@ export const buildUploadConfig = <T = UnData, D = UnData>(
     header: config.headers,
     timeout: config.timeout,
     formData: config.formData,
-  }) as UniApp.UploadFileOption;
+  };
+
+  const entries = Object.entries(result) as [
+    keyof typeof result,
+    (typeof result)[keyof typeof result],
+  ][];
+  return Object.fromEntries(
+    entries.filter(([k]) => result[k] != null),
+  ) as unknown as UniApp.UploadFileOption;
+};