@varlet/axle 0.2.1 → 0.2.3

package/README.md

@@ -218,7 +218,11 @@ const [users, getUsers, { loading, error, uploadProgress, downloadProgress, abor
   immediate: true,
   // The number of retries after a failed request, defaults 0
   retry: 3,
+  // Whether the value needs to be reset before requesting, defaults false
+  resetValue: true,
   // Request params, defaults {}
+  // When params is an object, it will be carried when sending the first request (immediate)
+  // When params is a function, it will be carried every time a request is sent.
   params: { current: 1, pageSize: 10 },
   // Axios config, see https://axios-http.com
   config: { headers: {} },

package/README.zh-CN.md

@@ -218,7 +218,11 @@ const [users, getUsers, { loading, error, uploadProgress, downloadProgress, abor
   immediate: true,
   // 错误重试次数, 默认值: 0
   retry: 3,
+  // 请求前是否需要重置 value, 默认值: false
+  resetValue: true,
   // 请求参数, 默认值: {}
+  // 当参数是一个对象时，发送第一个请求（immediate）时将携带它
+  // 当参数是一个函数时，每次发送请求时都会携带它。
   params: { current: 1, pageSize: 10 },
   // Axios 配置, see https://axios-http.com
   config: { headers: {} },

package/es/use.d.ts

@@ -4,6 +4,7 @@ export interface RunOptions<P> {
     url?: string;
     params?: P;
     config?: AxleRequestConfig;
+    resetValue?: boolean;
     _retryCount?: number;
 }
 export type Run<R, P> = (options?: RunOptions<P>) => Promise<R>;
@@ -18,8 +19,9 @@ export interface UseAxleOptions<V = any, R = any, P = Record<string, any>> {
     url: string;
     method: RunnerMethod;
     value?: V;
-    params?: P;
+    params?: P | (() => P);
     retry?: number;
+    resetValue?: boolean;
     config?: AxleRequestConfig;
     immediate?: boolean;
     onBefore?(refs: UseAxleRefs<V>): void;

package/es/use.js

@@ -1,9 +1,10 @@
 import { ref } from 'vue';
+import { isFunction } from '@varlet/shared';
 export function createUseAxle(options) {
     const { axle, onTransform: defaultOnTransform } = options;
     const useAxle = (options) => {
         var _a;
-        const { url, method, immediate, value: initialValue, params: initialParams, config: initialConfig, retry = 0, onBefore = () => { }, onAfter = () => { }, onTransform = (_a = defaultOnTransform) !== null && _a !== void 0 ? _a : ((response) => response), onSuccess = () => { }, onError = () => { }, } = options;
+        const { url, method, immediate, value: initialValue, resetValue: initialResetValue, params: initialParamsOrGetter, config: initialConfig, retry = 0, onBefore = () => { }, onAfter = () => { }, onTransform = (_a = defaultOnTransform) !== null && _a !== void 0 ? _a : ((response) => response), onSuccess = () => { }, onError = () => { }, } = options;
         const initialUrl = url;
         const value = ref(initialValue);
         const loading = ref(false);
@@ -20,17 +21,22 @@ export function createUseAxle(options) {
         };
         let controller = new AbortController();
         const run = async (options = {}) => {
-            var _a;
+            var _a, _b, _c;
             if (controller.signal.aborted) {
                 controller = new AbortController();
             }
+            const resetValue = (_b = (_a = options.resetValue) !== null && _a !== void 0 ? _a : initialResetValue) !== null && _b !== void 0 ? _b : false;
+            if (resetValue === true) {
+                value.value = initialValue;
+            }
             uploadProgress.value = 0;
             downloadProgress.value = 0;
-            const url = (_a = options.url) !== null && _a !== void 0 ? _a : initialUrl;
+            const url = (_c = options.url) !== null && _c !== void 0 ? _c : initialUrl;
             onBefore(refs);
             loading.value = true;
             try {
-                const response = await axle[method](url, options.params, Object.assign({ signal: controller.signal, onUploadProgress(event) {
+                const getterParams = isFunction(initialParamsOrGetter) ? initialParamsOrGetter() : {};
+                const response = await axle[method](url, Object.assign(Object.assign({}, getterParams), options.params), Object.assign({ signal: controller.signal, onUploadProgress(event) {
                         var _a;
                         uploadProgress.value = (_a = event.progress) !== null && _a !== void 0 ? _a : 0;
                     },
@@ -63,7 +69,7 @@ export function createUseAxle(options) {
         if (immediate) {
             run({
                 url: initialUrl,
-                params: initialParams,
+                params: isFunction(initialParamsOrGetter) ? {} : initialParamsOrGetter,
                 config: initialConfig,
             });
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@varlet/axle",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "Progressive request tool based on axios",
   "type": "module",
   "main": "es/index.js",
@@ -29,13 +29,13 @@
   "author": "haoziqaq <357229046@qq.com>",
   "license": "MIT",
   "dependencies": {
-    "@varlet/shared": "^2.16.5",
+    "@varlet/shared": "^2.19.2",
     "axios": "^1.4.0",
     "qs": "^6.11.0"
   },
   "devDependencies": {
     "@types/qs": "^6.9.7",
-    "@varlet/cli": "^2.16.5",
+    "@varlet/release": "0.0.3",
     "rimraf": "^5.0.1",
     "typescript": "^5.1.5",
     "vue": "3.3.4"
@@ -55,6 +55,6 @@
     "bootstrap": "pnpm i && pnpm build && pnpm --filter ./playground i",
     "dev": "tsc -w",
     "build": "rimraf ./es && tsc",
-    "release": "pnpm build && varlet-cli release"
+    "release": "pnpm build && vr release"
   }
 }