@seayoo-web/request 3.5.2 → 4.0.1

package/types/inc/type.d.ts

@@ -1,6 +1,6 @@
-import type { RequestGlobalConfig } from "./config";
+import type { GlobalConfigHelper } from "./config";
 import type { MaybePromise, TypeGuard, TypeGuardFn } from "@seayoo-web/utils";
-export type IBaseRequestBody = Blob | ArrayBuffer | FormData | URLSearchParams | string;
+export type BaseRequestBody = Blob | ArrayBuffer | FormData | URLSearchParams | string;
 export declare const RequestInternalError: {
     /** 响应数据校验失败 */
     readonly UnexpectResponse: "UnexpectResponse";
@@ -14,27 +14,33 @@ export declare const RequestInternalError: {
     readonly Timeout: "Timeout";
     /** 请求方法不被支持，在微信小程序环境下有效 */
     readonly NotSupport: "NotSupport";
-    /** url 格式错误 */
-    readonly URLFormatError: "URLFormatError";
 };
 export type RequestInternalError = (typeof RequestInternalError)[keyof typeof RequestInternalError];
+export type RequestMethod = "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD";
+export type RequestQueryParams = Record<string, string | number | boolean | null | undefined>;
 /** 通用网络请求工具的基本配置 */
-export interface IBaseRequestOptions {
+export interface BaseRequestOptions {
     /** 网络请求方法，默认 GET */
-    method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD";
+    method?: RequestMethod;
     /** 自定义 header 头 */
     headers?: Record<string, string>;
     /** url 参数 */
-    params?: Record<string, unknown>;
+    params?: RequestQueryParams;
     /** 发送的 body 内容，method 为 GET / HEAD / DELETE 时无效 */
-    body?: IBaseRequestBody | object | unknown[];
+    body?: BaseRequestBody | object | unknown[];
     /**
-     * 是否携带用户认证信息（cookie, basic http auth 等），默认 "same-origin"，
+     * 是否将请求响应为 ArrayBuffer
+     *
+     * 设置为 `true` 后将忽略 response body 解析，直接返回响应内容
+     */
+    asBuffer?: boolean;
+    /**
+     * 是否携带用户认证信息（cookie, basic http auth 等），默认 "same-origin"
      *
      * 使用 xhRequest 时，omit 无效，nodejs 环境无效
      */
     credentials?: "omit" | "same-origin" | "include";
-    /** 请求超时设置，单位 ms */
+    /** 请求超时设置，单位 ms，默认 10000 */
     timeout?: number;
     /**
      * 中断控制信号，仅仅浏览器环境支持
@@ -44,7 +50,7 @@ export interface IBaseRequestOptions {
     abort?: AbortSignal;
 }
 /** 重试请求的配置参数，暂不支持全局配置 */
-export interface IRetryRequestOptions {
+export interface RetryRequestOptions {
     /** 错误时重试的次数，不能超过 10 次，默认不重试 */
     maxRetry?: number;
     /**
@@ -54,7 +60,7 @@ export interface IRetryRequestOptions {
      *
      * `network` 仅仅网络错误时重试，但忽略 aborted / timeout 状态；
      */
-    retryResolve?: IRetryResolve;
+    retryResolve?: RetryResolve;
     /**
      * 两次重试的间隔，如果设置时间，则单位 ms，或者设置函数返回等待的时间（单位ms），默认 100，最小 100，函数参数 retryIndex 从 1 开始
      *
@@ -70,7 +76,7 @@ export interface IRetryRequestOptions {
 }
 /** 计算请求缓冲key的函数 */
 export type RequestCacheResolve = () => string | false;
-export interface IOtherRequestOptions {
+export interface OtherRequestOptions {
     /**
      * 如果设置为 false 则关闭通用提示
      *
@@ -82,11 +88,11 @@ export interface IOtherRequestOptions {
      *
      * 💡类型守卫校验不通过则会强制提示，即类型守卫校验提示不受此配置影响
      */
-    message?: false | ((result: IResponseResult, method: string, url: string, defaultMessage: string) => string | false | Error | {
+    message?: false | ((result: ResponseResult, method: string, url: string, defaultMessage: string) => string | false | Error | {
         message: string;
     });
     /** 自定义 ajax response 解析策略 */
-    responseRule?: IResponseRule;
+    responseRule?: ResponseRule;
     /**
      * 用于设置请求的缓冲时长，单位 ms，建议不小于 100，默认 500。设置为 0 则不缓冲
      */
@@ -99,11 +105,11 @@ export interface IOtherRequestOptions {
     cacheResolve?: RequestCacheResolve;
 }
 /** 对外工具接口的请求配置 */
-export type IRequestOptions = IBaseRequestOptions & IRetryRequestOptions & IOtherRequestOptions;
+export type RequestOptions = BaseRequestOptions & RetryRequestOptions & OtherRequestOptions;
 /** 请求的原始错误信息 */
 export type ERequestRawError = Error | ProgressEvent;
 /** 全局默认配置 */
-export type IRequestGlobalConfig = {
+export type RequestGlobalConfig = {
     /**
      * 设置全局 url 基础路径，必须要以 / 开头 或者完整的 api 地址，比如 /api 或 https://api.server.com/path
      */
@@ -121,9 +127,9 @@ export type IRequestGlobalConfig = {
         headers: Record<string, string>;
         params: Record<string, string>;
         method: string;
-        /** 要请求的url地址，不包含 params 参数 */
+        /** 即将要请求的 url 地址，不包含 params 参数 */
         url: string;
-        body?: IBaseRequestBody;
+        body?: BaseRequestBody;
     }) => MaybePromise<void | string>);
     /** 全局错误处理函数，仅在 statusCode 错误时触发 */
     errorHandler?: null | ((data: {
@@ -134,22 +140,21 @@ export type IRequestGlobalConfig = {
         url: string;
         headers: Record<string, string>;
         rawError?: ERequestRawError;
-        responseBody: string;
         sentryError: Error;
         sentryTags: Record<string, string | number>;
         sentryExtra: Record<string, unknown>;
     }) => void);
     /** 全局响应处理函数，任意状态都会触发 */
-    responseHandler?: null | ((result: IResponseResult, method: string, url: string) => void);
+    responseHandler?: null | ((result: ResponseResult, method: string, url: string) => void);
     /** 全局消息提示函数 */
     messageHandler?: null | ((isError: boolean, message: string, code: string, status: number) => void);
     /** 全局日志打印函数 */
-    logHandler?: null | ((log: IRequestLog) => void);
-} & Pick<IBaseRequestOptions, "credentials" | "timeout"> & IRetryRequestOptions & IOtherRequestOptions;
+    logHandler?: null | ((log: RequestLog) => void);
+} & Pick<BaseRequestOptions, "credentials" | "timeout"> & RetryRequestOptions & OtherRequestOptions;
 /**
  * 自定义重试检测方法
  */
-export type IRetryResolveFunc = (response: IRequestBaseResponse, count: number) => boolean;
+export type RetryResolveFunc = (response: RequestBaseResponse, count: number) => boolean;
 /**
  * 失败重试策略：
  *
@@ -157,17 +162,17 @@ export type IRetryResolveFunc = (response: IRequestBaseResponse, count: number)
  *
  * `network` 仅仅网络错误时重试，但忽略 aborted / timeout 状态；
  */
-export type IRetryResolve = "default" | "network" | number[] | IRetryResolveFunc;
+export type RetryResolve = "default" | "network" | number[] | RetryResolveFunc;
 /** 响应内容转化器 */
-export type IResponseBodyConverter = "camelize" | "snakify" | ((body: unknown) => unknown);
+export type ResponseBodyConverter = (body: unknown) => unknown;
 /** 响应内容解析规则配置 */
-export interface IResponseRule {
+export interface ResponseRule {
     /** http失败时 (status <200 || status >= 400) 解析策略 */
     failed: {
         /** 解析方式，如果解析方式为 json，则可以进一步指定错误消息字段 */
         resolve: "json" | "body";
-        /** 将响应内容进行转化，💡不再支持 "camelize"，"snakify" 参数 */
-        converter?: IResponseBodyConverter;
+        /** 将响应内容进行转化 */
+        converter?: ResponseBodyConverter;
         /** 解析错误消息的状态字段，比如 error 或 code，仅在 resolve 为 json 时有效，有值的话会替换 response 的 code */
         statusField?: string;
         /** 解析错误消息的字段，仅在 resolve 为 json 时有效 */
@@ -178,17 +183,13 @@ export interface IResponseRule {
         /**
          * http成功响应时，响应内容解析策略
          *
-         * - json
-         *
-         * 此时 response body 被格式化为 json，并根据后续配置进一步读取自定义状态和数据字段等信息
-         *
-         * - body
+         * - `json` 此时 response body 被格式化为 json，并根据后续配置进一步读取自定义状态和数据字段等信息
          *
-         * 此时 response body 被格式化为 json 并作为接口返回的数据使用，如果格式化失败，则返回 body 本身的字符串
+         * - `body` 此时 response body 被格式化为 json 并作为接口返回的数据使用，如果格式化失败，则返回 body 本身的字符串
          */
         resolve: "json" | "body";
-        /** 将响应内容进行转化，💡不再支持 "camelize"，"snakify" 参数 */
-        converter?: IResponseBodyConverter;
+        /** 将响应内容进行转化 */
+        converter?: ResponseBodyConverter;
         /** 表示自定义状态的字段名 */
         statusField?: string;
         /** 自定义状态成功时的取值 */
@@ -201,8 +202,10 @@ export interface IResponseRule {
         ignoreMessage?: string | string[];
     };
 }
+/** 请求响应体 */
+export type ResponseBody = string | null | ArrayBuffer | Buffer;
 /** 通用网络请求工具返回的内容 */
-export interface IRequestBaseResponse {
+export interface RequestBaseResponse {
     /** 最终发送请求的方法 */
     method: string;
     /** 最终发送请求的 url(带有params) */
@@ -211,15 +214,17 @@ export interface IRequestBaseResponse {
     status: number;
     /** 状态描述信息 */
     statusText: string;
+    /** 请求如果失败，则返回 RequestInternalError 错误 */
+    error?: RequestInternalError;
     /** 响应头，如果网络错误，则返回空对象 */
     headers?: Record<string, string | undefined>;
-    /** 响应体，如果网络错误或 204/202，则返回空或错误信息 */
-    body: string;
+    /** 响应体，如果网络错误或 204，则返回空或错误信息 */
+    body: ResponseBody;
     /** 原始的请求错误信息，仅当请求失败时有值，用以进行错误上报用 */
     rawError?: ERequestRawError;
 }
 /** 对外工具接口的返回内容 */
-export interface IResponseResult<T = unknown> {
+export interface ResponseResult<T = unknown> {
     /** 标记响应是否成功，包括检测 http statusCode 以及 自定义 Response rule 中的规则 */
     ok: boolean;
     /** 响应的 http 状态码，异常情况返回负数（仅代表异常，具体数值无含义） */
@@ -235,13 +240,13 @@ export interface IResponseResult<T = unknown> {
      */
     data: T;
 }
-export type ResponseWithType<T> = Promise<IResponseResult<T | null>>;
-export type ResponseWithoutType = Promise<IResponseResult>;
+export type ResponseWithType<T> = Promise<ResponseResult<T | null>>;
+export type ResponseWithoutType = Promise<ResponseResult>;
 export interface NetRequestCoreFn {
-    (url: string, config: RequestGlobalConfig, options?: IBaseRequestOptions): Promise<IRequestBaseResponse>;
+    (url: string, config: GlobalConfigHelper, options?: BaseRequestOptions): Promise<RequestBaseResponse>;
 }
 export interface NetRequestAgent {
-    (url: string, config: RequestGlobalConfig, options?: IRequestOptions): Promise<IResponseResult>;
+    (url: string, config: GlobalConfigHelper, options?: RequestOptions): Promise<ResponseResult>;
 }
 interface LogBase {
     method: string;
@@ -255,7 +260,7 @@ interface RetryCount extends LogBase {
 interface LogPrepare extends RetryCount {
     type: "prepare";
     /** 请求的参数 */
-    options?: IRequestOptions;
+    options?: RequestOptions;
     /** 自定义追加的请求 header 头 */
     headers?: Record<string, string>;
 }
@@ -264,7 +269,7 @@ interface LogReady extends LogBase {
     /** 实际发送的请求 header 头 */
     headers: Record<string, string>;
     /** 实际发送的数据 */
-    body?: IBaseRequestBody;
+    body?: BaseRequestBody;
     /** 实际发送设定的 timeout */
     timeout?: number;
 }
@@ -273,10 +278,10 @@ interface LogFinished extends RetryCount {
     /** 请求消耗的时间，单位 ms */
     cost: number;
     /** 请求响应的内容 */
-    response: IRequestBaseResponse;
+    response: RequestBaseResponse;
     /** 请求响应的 header */
     headers?: Record<string, string | undefined>;
 }
-export type IRequestLog = LogPrepare | LogReady | LogFinished;
-export type TypeGuardParam<T> = TypeGuard<T> | TypeGuardFn<T>;
+export type RequestLog = LogPrepare | LogReady | LogFinished;
+export type DataGuard<T> = TypeGuard<T> | TypeGuardFn<T>;
 export {};

package/types/inc/utils.d.ts

@@ -1,7 +1,12 @@
-import { IRetryResolve, IRetryResolveFunc } from "./type";
+import { RetryResolve, RetryResolveFunc, RequestQueryParams } from "./type";
 /** 简版 Object.fromEntries 以处理某些低版本浏览器和 webview 的问题 */
 export declare function fromEntries(kv: [string, string | undefined][]): Record<string, string>;
+export declare function convertParams(params?: RequestQueryParams): Record<string, string>;
+export declare function toString(data: unknown): string;
+export declare function convertError(e: unknown): Error;
+export declare function convertStringToArrayBuffer(content: string): Promise<ArrayBuffer>;
+export declare function addParamsToUrl(url: string, params: Record<string, string>): string;
 /**
  * 根据配置返回重试策略函数
  */
-export declare function getRetryCheckFn(retryResolve: IRetryResolve): IRetryResolveFunc;
+export declare function getRetryCheckFn(retryResolve: RetryResolve): RetryResolveFunc;

package/types/index.d.ts

@@ -1,11 +1,11 @@
 import { NetRequestHandler } from "./inc/main";
 import { xhrUpload } from "./inc/request.xhr";
-import type { IRequestGlobalConfig } from "./inc/type";
+import type { RequestGlobalConfig } from "./inc/type";
 export { jsonp, jsonx } from "./inc/jsonp";
 export { getResponseRulesDescription } from "./inc/rule";
 export { RequestInternalError } from "./inc/type";
-export type { NetRequestHandler } from "./inc/main";
-export type { IRequestOptions, IRequestGlobalConfig, IResponseRule, IResponseResult, IRequestLog } from "./inc/type";
+export type { NetRequestHandler, URLPlus, BufferRequestOptions } from "./inc/main";
+export type { RequestOptions, RequestGlobalConfig, ResponseRule, ResponseResult, RequestLog, RequestMethod, RequestQueryParams, } from "./inc/type";
 /**
  * 基于 xhr 模块的上传工具，支持上传进度
  */
@@ -15,59 +15,71 @@ export type NetRequestFactory = typeof NetRequest;
 /**
  * 创建新的实例空间，配置和缓存跟全局默认实例是隔离的，仅支持在浏览器环境使用
  */
-export declare function NetRequest(config?: IRequestGlobalConfig): NetRequestHandler;
+export declare function NetRequest(config?: RequestGlobalConfig): NetRequestHandler;
 /**
  * 设置全局默认的 Request Config
  */
-export declare const setGlobalConfig: (config: IRequestGlobalConfig) => void;
+export declare const setGlobalConfig: (config: RequestGlobalConfig) => void;
 /**
  * 发送一个网络请求
  */
-export declare const request: (url: string, options?: import("./inc/type").IRequestOptions) => Promise<import("./inc/type").IResponseResult<unknown>>;
+export declare const request: {
+    (op: {
+        url: string;
+        options?: import("./inc/type").RequestOptions;
+    }): Promise<import("./inc/type").ResponseResult<unknown>>;
+    <T>(op: {
+        url: string;
+        options?: import("./inc/type").RequestOptions;
+        guard: import("./inc/type").DataGuard<T>;
+    }): Promise<import("./inc/type").ResponseResult<T>>;
+};
 /**
  * 发送一个 HEAD 请求
  */
-export declare const head: (url: string, options?: import("./inc/type").IRequestOptions) => import("./inc/type").ResponseWithoutType;
+export declare const head: (url: string, params?: import("./inc/type").RequestQueryParams | null, options?: Omit<import("./inc/type").RequestOptions, "asBuffer">) => import("./inc/type").ResponseWithoutType;
 /**
  * 发送一个 GET 请求，请求自带 500ms 缓冲控制以应对并发场景，可选 typeGuard 用于检查数据类型
  */
 export declare const get: {
-    (url: string): import("./inc/type").ResponseWithoutType;
-    (url: string, typeGard: null, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithoutType;
-    <T>(url: string, typeGard: import("./inc/type").TypeGuardParam<T>, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithType<T>;
+    (url: string, params?: import("./inc/type").RequestQueryParams): import("./inc/type").ResponseWithoutType;
+    (url: string, params: import("./inc/type").RequestQueryParams | null, guard: null, options: import("./inc/main").BufferRequestOptions): import("./inc/type").ResponseWithType<ArrayBuffer>;
+    (url: string, params: import("./inc/type").RequestQueryParams | null, guard: null, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithoutType;
+    <T>(url: string, params: import("./inc/type").RequestQueryParams | null, guard: import("./inc/type").DataGuard<T>, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithType<T>;
 };
 /**
  * 发送一个 POST 请求，可选 typeGuard 用于检查数据类型
  */
 export declare const post: {
-    (url: string): import("./inc/type").ResponseWithoutType;
-    (url: string, data: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams): import("./inc/type").ResponseWithoutType;
-    (url: string, data: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, typeGard: null, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithoutType;
-    <T>(url: string, data: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, typeGard: import("./inc/type").TypeGuardParam<T>, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithType<T>;
+    (url: import("./inc/main").URLPlus, data?: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams): import("./inc/type").ResponseWithoutType;
+    (url: import("./inc/main").URLPlus, body: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, guard: null, options: import("./inc/main").BufferRequestOptions): import("./inc/type").ResponseWithType<ArrayBuffer>;
+    (url: import("./inc/main").URLPlus, body: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, guard: null, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithoutType;
+    <T>(url: import("./inc/main").URLPlus, body: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, guard: import("./inc/type").DataGuard<T>, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithType<T>;
 };
 /**
  * 发送一个 DELETE 请求，可选 typeGuard 用于检查数据类型
  */
 export declare const del: {
-    (url: string): import("./inc/type").ResponseWithoutType;
-    (url: string, typeGard: null, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithoutType;
-    <T>(url: string, typeGard: import("./inc/type").TypeGuardParam<T>, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithType<T>;
+    (url: string, params?: import("./inc/type").RequestQueryParams): import("./inc/type").ResponseWithoutType;
+    (url: string, params: import("./inc/type").RequestQueryParams | null, guard: null, options: import("./inc/main").BufferRequestOptions): import("./inc/type").ResponseWithType<ArrayBuffer>;
+    (url: string, params: import("./inc/type").RequestQueryParams | null, guard: null, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithoutType;
+    <T>(url: string, params: import("./inc/type").RequestQueryParams | null, guard: import("./inc/type").DataGuard<T>, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithType<T>;
 };
 /**
  * 发送一个 PUT 请求，可选 typeGuard 用于检查数据类型
  */
 export declare const put: {
-    (url: string): import("./inc/type").ResponseWithoutType;
-    (url: string, data: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams): import("./inc/type").ResponseWithoutType;
-    (url: string, data: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, typeGard: null, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithoutType;
-    <T>(url: string, data: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, typeGard: import("./inc/type").TypeGuardParam<T>, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithType<T>;
+    (url: import("./inc/main").URLPlus, body?: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams): import("./inc/type").ResponseWithoutType;
+    (url: import("./inc/main").URLPlus, body: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, guard: null, options: import("./inc/main").BufferRequestOptions): import("./inc/type").ResponseWithType<ArrayBuffer>;
+    (url: import("./inc/main").URLPlus, body: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, guard: null, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithoutType;
+    <T>(url: import("./inc/main").URLPlus, body: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, guard: import("./inc/type").DataGuard<T>, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithType<T>;
 };
 /**
  * 发送一个 PATCH 请求，可选 typeGuard 用于检查数据类型
  */
 export declare const patch: {
-    (url: string): import("./inc/type").ResponseWithoutType;
-    (url: string, data: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams): import("./inc/type").ResponseWithoutType;
-    (url: string, data: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, typeGard: null, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithoutType;
-    <T>(url: string, data: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, typeGard: import("./inc/type").TypeGuardParam<T>, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithType<T>;
+    (url: import("./inc/main").URLPlus, data?: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams): import("./inc/type").ResponseWithoutType;
+    (url: import("./inc/main").URLPlus, body: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, guard: null, options: import("./inc/main").BufferRequestOptions): import("./inc/type").ResponseWithType<ArrayBuffer>;
+    (url: import("./inc/main").URLPlus, body: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, guard: null, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithoutType;
+    <T>(url: import("./inc/main").URLPlus, body: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, guard: import("./inc/type").DataGuard<T>, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithType<T>;
 };

package/types/node.d.ts

@@ -1,61 +1,63 @@
 import { NetRequestHandler } from "./inc/main";
-import type { IRequestGlobalConfig } from "./inc/type";
+import type { RequestGlobalConfig } from "./inc/type";
 export { getResponseRulesDescription } from "./inc/rule";
 export { RequestInternalError } from "./inc/type";
-export type { NetRequestHandler } from "./inc/main";
-export type { IRequestOptions, IRequestGlobalConfig, IResponseRule, IResponseResult, IRequestLog } from "./inc/type";
+export type { NetRequestHandler, URLPlus, BufferRequestOptions } from "./inc/main";
+export type { RequestOptions, RequestGlobalConfig, ResponseRule, ResponseResult, RequestLog, RequestMethod, RequestQueryParams, } from "./inc/type";
 /**
  * 创建新的实例空间，配置和缓存跟全局默认实例是隔离的
  */
-export declare function NetRequest(config?: IRequestGlobalConfig): NetRequestHandler;
+export declare function NetRequest(config?: RequestGlobalConfig): NetRequestHandler;
 /**
  * 设置全局默认的 Request Config
  */
-export declare const setGlobalConfig: (config: IRequestGlobalConfig) => void;
+export declare const setGlobalConfig: (config: RequestGlobalConfig) => void;
 /**
  * 发送一个 HEAD 请求
  */
-export declare const head: (url: string, options?: import("./inc/type").IRequestOptions) => import("./inc/type").ResponseWithoutType;
+export declare const head: (url: string, params?: import("./inc/type").RequestQueryParams | null, options?: Omit<import("./inc/type").RequestOptions, "asBuffer">) => import("./inc/type").ResponseWithoutType;
 /**
  * 发送一个 GET 请求，请求自带 500ms 缓冲控制以应对并发场景，可选 typeGuard 用于检查数据类型
  */
 export declare const get: {
-    (url: string): import("./inc/type").ResponseWithoutType;
-    (url: string, typeGard: null, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithoutType;
-    <T>(url: string, typeGard: import("./inc/type").TypeGuardParam<T>, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithType<T>;
+    (url: string, params?: import("./inc/type").RequestQueryParams): import("./inc/type").ResponseWithoutType;
+    (url: string, params: import("./inc/type").RequestQueryParams | null, guard: null, options: import("./inc/main").BufferRequestOptions): import("./inc/type").ResponseWithType<ArrayBuffer>;
+    (url: string, params: import("./inc/type").RequestQueryParams | null, guard: null, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithoutType;
+    <T>(url: string, params: import("./inc/type").RequestQueryParams | null, guard: import("./inc/type").DataGuard<T>, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithType<T>;
 };
 /**
  * 发送一个 POST 请求，可选 typeGuard 用于检查数据类型
  */
 export declare const post: {
-    (url: string): import("./inc/type").ResponseWithoutType;
-    (url: string, data: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams): import("./inc/type").ResponseWithoutType;
-    (url: string, data: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, typeGard: null, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithoutType;
-    <T>(url: string, data: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, typeGard: import("./inc/type").TypeGuardParam<T>, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithType<T>;
+    (url: import("./inc/main").URLPlus, data?: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams): import("./inc/type").ResponseWithoutType;
+    (url: import("./inc/main").URLPlus, body: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, guard: null, options: import("./inc/main").BufferRequestOptions): import("./inc/type").ResponseWithType<ArrayBuffer>;
+    (url: import("./inc/main").URLPlus, body: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, guard: null, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithoutType;
+    <T>(url: import("./inc/main").URLPlus, body: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, guard: import("./inc/type").DataGuard<T>, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithType<T>;
 };
 /**
  * 发送一个 DELETE 请求，可选 typeGuard 用于检查数据类型
  */
 export declare const del: {
-    (url: string): import("./inc/type").ResponseWithoutType;
-    (url: string, typeGard: null, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithoutType;
-    <T>(url: string, typeGard: import("./inc/type").TypeGuardParam<T>, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithType<T>;
+    (url: string, params?: import("./inc/type").RequestQueryParams): import("./inc/type").ResponseWithoutType;
+    (url: string, params: import("./inc/type").RequestQueryParams | null, guard: null, options: import("./inc/main").BufferRequestOptions): import("./inc/type").ResponseWithType<ArrayBuffer>;
+    (url: string, params: import("./inc/type").RequestQueryParams | null, guard: null, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithoutType;
+    <T>(url: string, params: import("./inc/type").RequestQueryParams | null, guard: import("./inc/type").DataGuard<T>, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithType<T>;
 };
 /**
  * 发送一个 PUT 请求，可选 typeGuard 用于检查数据类型
  */
 export declare const put: {
-    (url: string): import("./inc/type").ResponseWithoutType;
-    (url: string, data: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams): import("./inc/type").ResponseWithoutType;
-    (url: string, data: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, typeGard: null, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithoutType;
-    <T>(url: string, data: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, typeGard: import("./inc/type").TypeGuardParam<T>, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithType<T>;
+    (url: import("./inc/main").URLPlus, body?: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams): import("./inc/type").ResponseWithoutType;
+    (url: import("./inc/main").URLPlus, body: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, guard: null, options: import("./inc/main").BufferRequestOptions): import("./inc/type").ResponseWithType<ArrayBuffer>;
+    (url: import("./inc/main").URLPlus, body: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, guard: null, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithoutType;
+    <T>(url: import("./inc/main").URLPlus, body: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, guard: import("./inc/type").DataGuard<T>, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithType<T>;
 };
 /**
  * 发送一个 PATCH 请求，可选 typeGuard 用于检查数据类型
  */
 export declare const patch: {
-    (url: string): import("./inc/type").ResponseWithoutType;
-    (url: string, data: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams): import("./inc/type").ResponseWithoutType;
-    (url: string, data: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, typeGard: null, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithoutType;
-    <T>(url: string, data: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, typeGard: import("./inc/type").TypeGuardParam<T>, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithType<T>;
+    (url: import("./inc/main").URLPlus, data?: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams): import("./inc/type").ResponseWithoutType;
+    (url: import("./inc/main").URLPlus, body: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, guard: null, options: import("./inc/main").BufferRequestOptions): import("./inc/type").ResponseWithType<ArrayBuffer>;
+    (url: import("./inc/main").URLPlus, body: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, guard: null, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithoutType;
+    <T>(url: import("./inc/main").URLPlus, body: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, guard: import("./inc/type").DataGuard<T>, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithType<T>;
 };

package/types/wx.d.ts

@@ -1,52 +1,54 @@
 import { NetRequestHandler } from "./inc/main";
-import type { IRequestGlobalConfig } from "./inc/type";
+import type { RequestGlobalConfig } from "./inc/type";
 export { getResponseRulesDescription } from "./inc/rule";
 export { RequestInternalError } from "./inc/type";
-export type { NetRequestHandler } from "./inc/main";
-export type { IRequestOptions, IRequestGlobalConfig, IResponseRule, IResponseResult, IRequestLog } from "./inc/type";
+export type { NetRequestHandler, URLPlus, BufferRequestOptions } from "./inc/main";
+export type { RequestOptions, RequestGlobalConfig, ResponseRule, ResponseResult, RequestLog, RequestMethod, RequestQueryParams, } from "./inc/type";
 /**
  * 创建新的实例空间，配置和缓存跟全局默认实例是隔离的
  */
-export declare function NetRequest(config?: IRequestGlobalConfig): NetRequestHandler;
+export declare function NetRequest(config?: RequestGlobalConfig): NetRequestHandler;
 /**
  * 设置全局默认的 Request Config
  */
-export declare const setGlobalConfig: (config: IRequestGlobalConfig) => void;
+export declare const setGlobalConfig: (config: RequestGlobalConfig) => void;
 /**
  * 发送一个 HEAD 请求
  */
-export declare const head: (url: string, options?: import("./inc/type").IRequestOptions) => import("./inc/type").ResponseWithoutType;
+export declare const head: (url: string, params?: import("./inc/type").RequestQueryParams | null, options?: Omit<import("./inc/type").RequestOptions, "asBuffer">) => import("./inc/type").ResponseWithoutType;
 /**
  * 发送一个 GET 请求，请求自带 500ms 缓冲控制以应对并发场景，可选 typeGuard 用于检查数据类型
  */
 export declare const get: {
-    (url: string): import("./inc/type").ResponseWithoutType;
-    (url: string, typeGard: null, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithoutType;
-    <T>(url: string, typeGard: import("./inc/type").TypeGuardParam<T>, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithType<T>;
+    (url: string, params?: import("./inc/type").RequestQueryParams): import("./inc/type").ResponseWithoutType;
+    (url: string, params: import("./inc/type").RequestQueryParams | null, guard: null, options: import("./inc/main").BufferRequestOptions): import("./inc/type").ResponseWithType<ArrayBuffer>;
+    (url: string, params: import("./inc/type").RequestQueryParams | null, guard: null, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithoutType;
+    <T>(url: string, params: import("./inc/type").RequestQueryParams | null, guard: import("./inc/type").DataGuard<T>, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithType<T>;
 };
 /**
  * 发送一个 POST 请求，可选 typeGuard 用于检查数据类型
  */
 export declare const post: {
-    (url: string): import("./inc/type").ResponseWithoutType;
-    (url: string, data: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams): import("./inc/type").ResponseWithoutType;
-    (url: string, data: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, typeGard: null, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithoutType;
-    <T>(url: string, data: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, typeGard: import("./inc/type").TypeGuardParam<T>, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithType<T>;
+    (url: import("./inc/main").URLPlus, data?: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams): import("./inc/type").ResponseWithoutType;
+    (url: import("./inc/main").URLPlus, body: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, guard: null, options: import("./inc/main").BufferRequestOptions): import("./inc/type").ResponseWithType<ArrayBuffer>;
+    (url: import("./inc/main").URLPlus, body: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, guard: null, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithoutType;
+    <T>(url: import("./inc/main").URLPlus, body: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, guard: import("./inc/type").DataGuard<T>, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithType<T>;
 };
 /**
  * 发送一个 DELETE 请求，可选 typeGuard 用于检查数据类型
  */
 export declare const del: {
-    (url: string): import("./inc/type").ResponseWithoutType;
-    (url: string, typeGard: null, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithoutType;
-    <T>(url: string, typeGard: import("./inc/type").TypeGuardParam<T>, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithType<T>;
+    (url: string, params?: import("./inc/type").RequestQueryParams): import("./inc/type").ResponseWithoutType;
+    (url: string, params: import("./inc/type").RequestQueryParams | null, guard: null, options: import("./inc/main").BufferRequestOptions): import("./inc/type").ResponseWithType<ArrayBuffer>;
+    (url: string, params: import("./inc/type").RequestQueryParams | null, guard: null, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithoutType;
+    <T>(url: string, params: import("./inc/type").RequestQueryParams | null, guard: import("./inc/type").DataGuard<T>, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithType<T>;
 };
 /**
  * 发送一个 PUT 请求，可选 typeGuard 用于检查数据类型
  */
 export declare const put: {
-    (url: string): import("./inc/type").ResponseWithoutType;
-    (url: string, data: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams): import("./inc/type").ResponseWithoutType;
-    (url: string, data: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, typeGard: null, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithoutType;
-    <T>(url: string, data: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, typeGard: import("./inc/type").TypeGuardParam<T>, options?: import("./inc/type").IRequestOptions): import("./inc/type").ResponseWithType<T>;
+    (url: import("./inc/main").URLPlus, body?: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams): import("./inc/type").ResponseWithoutType;
+    (url: import("./inc/main").URLPlus, body: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, guard: null, options: import("./inc/main").BufferRequestOptions): import("./inc/type").ResponseWithType<ArrayBuffer>;
+    (url: import("./inc/main").URLPlus, body: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, guard: null, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithoutType;
+    <T>(url: import("./inc/main").URLPlus, body: string | object | unknown[] | ArrayBuffer | Blob | FormData | URLSearchParams, guard: import("./inc/type").DataGuard<T>, options?: import("./inc/type").RequestOptions): import("./inc/type").ResponseWithType<T>;
 };