@ruan-cat/utils 3.2.0 → 4.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruan-cat/utils",
-  "version": "3.2.0",
+  "version": "4.0.0",
   "description": "阮喵喵工具集合。一个纯typescript库，也提供纯js文件。",
   "type": "module",
   "main": "./src/index.ts",

package/src/vueuse/useAxios/index.ts

@@ -1,10 +1,10 @@
 import type { RequiredPick } from "type-plus";
 import type { AxiosRequestConfig, AxiosResponse, AxiosInstance } from "axios";
-import type { UseAxiosOptions, UseAxiosReturn } from "@vueuse/integrations/useAxios";
+import type { UseAxiosOptions, UseAxiosOptionsBase, UseAxiosReturn } from "@vueuse/integrations/useAxios";
 import { useAxios } from "@vueuse/integrations/useAxios";
 
 /** 在封装函数时 需要使用该类型 */
-export { UseAxiosOptions };
+export { UseAxiosOptions, UseAxiosOptionsBase };
 
 /** 拓展的类型参数 用于约束必填的字段 */
 export type KeyAxiosRequestConfig<D = any> = keyof AxiosRequestConfig<D>;
@@ -12,7 +12,10 @@ export type KeyAxiosRequestConfig<D = any> = keyof AxiosRequestConfig<D>;
 /** 填写key值的帮助类型 */
 export type KeyHelper<K extends KeyAxiosRequestConfig> = K;
 
+/** @deprecated 在v2版本中，我们不使用该工具来约束删减类型 */
 export type RemoveUrl<T extends KeyAxiosRequestConfig> = Exclude<T, "url">;
+
+/** @deprecated 在v2版本中，我们不使用该工具来约束删减类型 */
 export type RemoveUrlMethod<T extends KeyAxiosRequestConfig> = Exclude<T, "url" | "method">;
 
 /**
@@ -66,39 +69,46 @@ declare module "@vueuse/integrations/useAxios" {
 		url: string,
 		config: AxiosRequestConfig<D>,
 		instance: AxiosInstance,
-		options?: UseAxiosOptions,
+		options?: UseAxiosOptionsBase,
 	): StrictUseAxiosReturn<T, K, R, D> & Promise<StrictUseAxiosReturn<T, K, R, D>>;
 }
 
-/** 包装器的参数 */
+/** 包装器的参数 @version 2 */
 export interface UseAxiosWrapperParams<
-	/**
-	 * 业务数据类型
-	 * @description
-	 * 必须先填写业务类型
-	 */
-	T = any,
 	/**
 	 * AxiosRequestConfig 默认必填的字段
 	 * @description
-	 * 用于约束其他类型的字段
+	 * key是首先必填的字段 必须要约束axios请求配置的可选项值
 	 *
-	 * 然后才能填写必传的参数类型
-	 *
-	 * 默认为 必填url请求地址的 config 请求配置
+	 * 该key值不再默认要求url是必填项 不做严格约束
 	 */
-	K extends KeyAxiosRequestConfig<D> = "url",
+	K extends KeyAxiosRequestConfig,
 	/**
-	 * UseAxiosOptions 的派生类型
+	 * 业务数据类型
+	 * @description
+	 * axios的返回值类型 二版本不再默认提供any类型
+	 *
+	 * 下游工具必须主动传递类型
 	 */
-	UseAxiosOptionsLike extends UseAxiosOptions = UseAxiosOptions,
+	T,
+	/** UseAxiosOptionsBase 的派生类型 */
+	UseAxiosOptionsLike extends UseAxiosOptionsBase = UseAxiosOptionsBase<T>,
 	/**
 	 * AxiosRequestConfig 用的类型
 	 * @description
-	 * 最后才可以传递此类型
+	 * 通常是 axios 的输入值
 	 */
 	D = any,
 > {
+	/**
+	 * 接口的url
+	 * @description
+	 * 接口必须要有url地址，该url迁移到此处专门设置
+	 *
+	 * 不要求在 axios 配置内必传url了。
+	 * @version 2
+	 */
+	url: string;
 	/**
 	 * axios的配置类型
 	 * @description
@@ -123,17 +133,19 @@ export interface UseAxiosWrapperParams<
  * 其本质是对 useAxios 函数的封装，仅仅是包装了参数层
  *
  * 预期设计成一个万能的 通用的请求函数
+ *
+ * 类型必传key T UseAxiosOptionsLike
+ * @version 2
  */
-export function useAxiosWrapper<T, K extends KeyAxiosRequestConfig, D = any>(params: UseAxiosWrapperParams) {
-	const {
-		config: { url },
-		config,
-		instance,
-		options,
-	} = params;
-	// 跳转到 vueuse 内的函数声明
-	// return useAxios<T, AxiosResponse<T>, D>(url, config, instance, options);
-
-	// 跳转到我们拓展的函数声明
+export function useAxiosWrapper<
+	K extends KeyAxiosRequestConfig,
+	T,
+	UseAxiosOptionsLike extends UseAxiosOptionsBase,
+	D = any,
+>(params: UseAxiosWrapperParams<K, T, UseAxiosOptionsLike, D>) {
+	const { config = {}, instance, options = {} } = params;
+	const url = params.url || "";
 	return useAxios<T, K, AxiosResponse<T>, D>(url, config, instance, options);
 }
+
+export * from "./v2.ts";

package/src/vueuse/useAxios/v2.ts

@@ -0,0 +1,82 @@
+/**
+ * 这里是第一版本的工具
+ * 已经不再使用
+ */
+import type { RequiredPick } from "type-plus";
+import type { AxiosResponse, AxiosInstance } from "axios";
+import type { UseAxiosOptionsBase, UseAxiosOptions } from "@vueuse/integrations/useAxios";
+import { useAxios } from "@vueuse/integrations/useAxios";
+import type { CreateAxiosRequestConfig, KeyAxiosRequestConfig } from "./index.ts";
+
+/**
+ * 包装器的参数
+ * @version 1
+ * @deprecated
+ */
+export interface UseAxiosWrapperParamsV1<
+	/**
+	 * 业务数据类型
+	 * @description
+	 * 必须先填写业务类型
+	 */
+	T = any,
+	/**
+	 * AxiosRequestConfig 默认必填的字段
+	 * @description
+	 * 用于约束其他类型的字段
+	 *
+	 * 然后才能填写必传的参数类型
+	 *
+	 * 默认为 必填url请求地址的 config 请求配置
+	 */
+	K extends KeyAxiosRequestConfig<D> = "url",
+	/**
+	 * UseAxiosOptions 的派生类型
+	 */
+	UseAxiosOptionsLike extends UseAxiosOptions = UseAxiosOptions,
+	/**
+	 * AxiosRequestConfig 用的类型
+	 * @description
+	 * 最后才可以传递此类型
+	 */
+	D = any,
+> {
+	/**
+	 * axios的配置类型
+	 * @description
+	 * 默认为 必填url请求地址的 config 请求配置
+	 */
+	config: CreateAxiosRequestConfig<K, D>;
+
+	/**
+	 * axios实例
+	 * @description
+	 * 对于包装器函数而言 必须传递有意义的请求实例
+	 */
+	instance: AxiosInstance;
+
+	/** useAxios 的选项配置 */
+	options: UseAxiosOptionsLike;
+}
+
+/**
+ * useAxios 的包装函数
+ * @description
+ * 其本质是对 useAxios 函数的封装，仅仅是包装了参数层
+ *
+ * 预期设计成一个万能的 通用的请求函数
+ * @version 1
+ */
+export function useAxiosWrapperV1<T, K extends KeyAxiosRequestConfig, D = any>(params: UseAxiosWrapperParamsV1) {
+	const {
+		config: { url },
+		config,
+		instance,
+		options,
+	} = params;
+	// 跳转到 vueuse 内的函数声明
+	// return useAxios<T, AxiosResponse<T>, D>(url, config, instance, options);
+
+	// 跳转到我们拓展的函数声明
+	return useAxios<T, K, AxiosResponse<T>, D>(url, config, instance, options);
+}