@uni-helper/axios-adapter 1.5.0 → 1.5.1

package/README.md

@@ -12,59 +12,73 @@ pnpm i @uni-helper/axios-adapter axios
 
 ## 使用
 
+<details>
+<summary>点击查看平台兼容性</summary>
+
+| Vue2 | Vue3 |
+| ---- | ---- |
+| √    | √    |
+
+| App                                      | 快应用 | 微信小程序 | 支付宝小程序 | 百度小程序 | 字节小程序 | QQ 小程序 |
+| ---------------------------------------- | ------ | ---------- | ------------ | ---------- | ---------- | --------- |
+| HBuilderX 3.4.8<br/>app-vue<br/>app-nvue | √      | √          | √            | √          | √          | √         |
+
+| 钉钉小程序 | 快手小程序 | 飞书小程序 | 京东小程序 |
+| ---------- | ---------- | ---------- | ---------- |
+| √          | √          | √          | √          |
+
+| H5-Safari | Android Browser | 微信浏览器(Android) | QQ 浏览器(Android) | Chrome | IE  | Edge | Firefox | PC-Safari |
+| --------- | --------------- | ------------------- | ------------------ | ------ | --- | ---- | ------- | --------- |
+| √         | √               | √                   | √                  | √      | √   | √    | √       | √         |
+
+</details>
+
 ### 基本用法
 
 ```ts
 import axios from "axios";
 import { createUniAppAxiosAdapter } from "@uni-helper/axios-adapter";
 
-const instance = axios.create({
-  adapter: createUniAppAxiosAdapter(),
-});
+axios.defaults.adapter = createUniAppAxiosAdapter();
 ```
 
-### 与 useAxios 一起使用
+或者创建自定义实例
 
 ```ts
 import axios from "axios";
-import { useAxios } from "@vueuse/integrations/useAxios";
 import { createUniAppAxiosAdapter } from "@uni-helper/axios-adapter";
 
-const instance = axios.create({
-  adapter: createUniAppAxiosAdapter(),
-});
-
-const { data, isFinished } = useAxios("/posts", instance);
+const instance = axios.create({ adapter: createUniAppAxiosAdapter() });
 ```
 
-### 上传和下载
+### 与 [useAxios](https://vueuse.org/integrations/useAxios/) 一起使用
 
 ```ts
 import axios from "axios";
 import { createUniAppAxiosAdapter } from "@uni-helper/axios-adapter";
 
-const instance = axios.create({
-  adapter: createUniAppAxiosAdapter(),
-});
+axios.defaults.adapter = createUniAppAxiosAdapter();
+const { data, isFinished } = useAxios("/posts");
+```
 
-// 一个假文件
-const data = new File([new Blob()], "emptyFile");
+### 上传和下载
 
+```ts
 // 下载
-instance.download("/");
+axios.download("/");
 // or
-instance.request({
+axios.request({
   url: "/",
   method: "download",
 });
 
 // 上传
-instance.upload("/", data);
+axios.upload("/", new File([new Blob()], "fake file"));
 // or
-instance.request({
+axios.request({
   url: "/",
   method: "upload",
-  data,
+  data: new File([new Blob()], "fake file"),
 });
 ```
 
@@ -84,15 +98,14 @@ export default {
   ],
 }
 ```
+
 > [!WARNING]
 > 这个插件通过将 `FormData` 和 `Blob` 导出为空 `class`来解决兼容性问题，如果你确实需要的话，使用 `pnpm add miniprogram-formdata miniprogram-blob` 来安装对应的 polyfill 即可，插件会自动使用。
 
 如果你使用的是 Vue CLI，改用 `@uni-helper/axios-adapter/webpack` 即可
 
-## 客户端类型
+### 版本
 
-提供了 upload 和 download 方法的类型提示，及 AxiosRequestConfig 支持传递 uniapp 特有参数
+自 1.4.0 开始，请始终保持主版本号和次版本号与 axios 一致。例如当你安装了 1.5.1 版本时，你可以安装 axios 的 1.5.x 版本。
 
-```ts
-/// <reference types="@uni-helper/axios-adapter/client" />
-```
+这样做的目的是始终支持最新的 axios。

package/dist/index.d.cts

@@ -1,6 +1,18 @@
 import { AxiosAdapter } from 'axios';
 import { U as UserOptions } from './types-76de936f.js';
 
+declare module "axios" {
+    interface AxiosRequestConfig extends Omit<UniApp.RequestOptions, "success" | "fail" | "complete" | "header">, Omit<UniApp.UploadFileOption, "success" | "fail" | "complete" | "header" | "formData">, Omit<UniApp.DownloadFileOption, "success" | "fail" | "complete" | "header">, Partial<Pick<UniApp.RequestTask, "onHeadersReceived">> {
+    }
+    interface AxiosResponse {
+        cookies?: string[];
+    }
+    interface Axios {
+        upload<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: AxiosRequestConfig<D>): Promise<R>;
+        download<T = any, R = AxiosResponse<T>, D = any>(url: string, config?: AxiosRequestConfig<D>): Promise<R>;
+    }
+}
+
 declare const createUniAppAxiosAdapter: (userOptions?: UserOptions) => AxiosAdapter;
 
 export { createUniAppAxiosAdapter };

package/dist/index.d.ts

@@ -1,6 +1,18 @@
 import { AxiosAdapter } from 'axios';
 import { U as UserOptions } from './types-76de936f.js';
 
+declare module "axios" {
+    interface AxiosRequestConfig extends Omit<UniApp.RequestOptions, "success" | "fail" | "complete" | "header">, Omit<UniApp.UploadFileOption, "success" | "fail" | "complete" | "header" | "formData">, Omit<UniApp.DownloadFileOption, "success" | "fail" | "complete" | "header">, Partial<Pick<UniApp.RequestTask, "onHeadersReceived">> {
+    }
+    interface AxiosResponse {
+        cookies?: string[];
+    }
+    interface Axios {
+        upload<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: AxiosRequestConfig<D>): Promise<R>;
+        download<T = any, R = AxiosResponse<T>, D = any>(url: string, config?: AxiosRequestConfig<D>): Promise<R>;
+    }
+}
+
 declare const createUniAppAxiosAdapter: (userOptions?: UserOptions) => AxiosAdapter;
 
 export { createUniAppAxiosAdapter };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@uni-helper/axios-adapter",
   "type": "module",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "license": "MIT",
   "author": {
     "name": "kejunmao",
@@ -51,9 +51,6 @@
         "types": "./dist/webpack.d.cts",
         "default": "./dist/webpack.cjs"
       }
-    },
-    "./client": {
-      "types": "./client.d.ts"
     }
   },
   "main": "./dist/index.js",

package/client.d.ts

@@ -1,35 +0,0 @@
-declare module "axios" {
-  export interface AxiosRequestConfig
-    extends Omit<
-        UniApp.RequestOptions,
-        "success" | "fail" | "complete" | "header"
-      >,
-      Omit<
-        UniApp.UploadFileOption,
-        "success" | "fail" | "complete" | "header" | "formData"
-      >,
-      Omit<
-        UniApp.DownloadFileOption,
-        "success" | "fail" | "complete" | "header"
-      >,
-      Partial<Pick<UniApp.RequestTask, "onHeadersReceived">> {}
-
-  export interface AxiosResponse {
-    cookies?: string[];
-  }
-
-  export interface Axios {
-    upload<T = any, R = AxiosResponse<T>, D = any>(
-      url: string,
-      data?: D,
-      config?: AxiosRequestConfig<D>
-    ): Promise<R>;
-
-    download<T = any, R = AxiosResponse<T>, D = any>(
-      url: string,
-      config?: AxiosRequestConfig<D>
-    ): Promise<R>;
-  }
-}
-
-export {};