@varlet/axle 0.2.2 → 0.2.4-alpha.1701343124078

package/README.md

@@ -218,6 +218,8 @@ 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.

package/README.zh-CN.md

@@ -218,6 +218,8 @@ const [users, getUsers, { loading, error, uploadProgress, downloadProgress, abor
   immediate: true,
   // 错误重试次数, 默认值: 0
   retry: 3,
+  // 请求前是否需要重置 value, 默认值: false
+  resetValue: true,
   // 请求参数, 默认值: {}
   // 当参数是一个对象时，发送第一个请求（immediate）时将携带它
   // 当参数是一个函数时，每次发送请求时都会携带它。

package/es/index.d.ts

@@ -1 +1,2 @@
 export * from './instance.js';
+export * from './interceptors';

package/es/index.js

@@ -1 +1,2 @@
 export * from './instance.js';
+export * from './interceptors';

package/es/instance.d.ts

@@ -1,4 +1,4 @@
-import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, HeadersDefaults, ResponseType } from 'axios';
+import type { AxiosInstance, AxiosInterceptorOptions, AxiosRequestConfig, AxiosResponse, HeadersDefaults, InternalAxiosRequestConfig, ResponseType } from 'axios';
 export type AxleRequestConfig = AxiosRequestConfig & {
     exceptionMessage?: any;
 };
@@ -7,6 +7,13 @@ export type ModifyRunner = <T = any, R = AxiosResponse<T>>(url: string, params?:
 export type FetchMethod = 'get' | 'delete' | 'options' | 'head';
 export type ModifyMethod = 'post' | 'put' | 'patch';
 export type RunnerMethod = keyof Omit<AxleInstance, 'axios' | 'getHeaders' | 'setHeader' | 'removeHeader'>;
+export interface Interceptor<V> {
+    onFulfilled?: ((value: V) => any) | null;
+    onRejected?: ((error: any) => any) | null;
+    options?: AxiosInterceptorOptions;
+}
+export type RequestInterceptor = Interceptor<InternalAxiosRequestConfig>;
+export type ResponseInterceptor<V = AxiosResponse<any, any>> = Interceptor<V>;
 export type AxleInstance = {
     get: FetchRunner;
     getBlob: FetchRunner;
@@ -44,6 +51,8 @@ export type AxleInstance = {
     getHeaders(): HeadersDefaults['common'];
     setHeader(key: string, value: string): void;
     removeHeader(key: string | string[]): void;
+    useRequestInterceptor(interceptor: RequestInterceptor): void;
+    useResponseInterceptor(interceptor: ResponseInterceptor): void;
     axios: AxiosInstance;
 };
 export declare function createFetchRunner(service: AxiosInstance, method: FetchMethod, responseType: ResponseType): <T, R = AxiosResponse<T, any>>(url: string, params?: any, config?: AxleRequestConfig) => Promise<R>;

package/es/instance.js

@@ -51,6 +51,12 @@ export function createAxle(config = {}) {
         }
         key.forEach((k) => Reflect.deleteProperty(service.defaults.headers['common'], k));
     }
+    function useRequestInterceptor(interceptor) {
+        service.interceptors.request.use(interceptor.onFulfilled, interceptor.onRejected, interceptor.options);
+    }
+    function useResponseInterceptor(interceptor) {
+        service.interceptors.response.use(interceptor.onFulfilled, interceptor.onRejected, interceptor.options);
+    }
     return {
         get: createFetchRunner(service, 'get', 'json'),
         getBlob: createFetchRunner(service, 'get', 'blob'),
@@ -88,6 +94,8 @@ export function createAxle(config = {}) {
         getHeaders,
         setHeader,
         removeHeader,
+        useRequestInterceptor,
+        useResponseInterceptor,
         axios: service,
     };
 }

package/es/interceptors/index.d.ts

@@ -0,0 +1,2 @@
+export * from './requestHeadersInterceptor';
+export * from './responseBlobInterceptor';

package/es/interceptors/index.js

@@ -0,0 +1,2 @@
+export * from './requestHeadersInterceptor';
+export * from './responseBlobInterceptor';

package/es/interceptors/requestHeadersInterceptor.d.ts

@@ -0,0 +1,7 @@
+import type { RequestInterceptor } from '../instance';
+import type { AxiosInterceptorOptions } from 'axios';
+export interface RequestHeadersInterceptorOptions {
+    headers?: Record<string, string> | (() => Record<string, string>);
+    axiosInterceptorOptions?: AxiosInterceptorOptions;
+}
+export declare function requestHeadersInterceptor(options?: RequestHeadersInterceptorOptions): RequestInterceptor;

package/es/interceptors/requestHeadersInterceptor.js

@@ -0,0 +1,18 @@
+import { isFunction } from '@varlet/shared';
+export function requestHeadersInterceptor(options = {}) {
+    const { headers: headersOrGetter } = options;
+    return {
+        onFulfilled(config) {
+            var _a;
+            const headers = (_a = (isFunction(headersOrGetter) ? headersOrGetter() : headersOrGetter)) !== null && _a !== void 0 ? _a : {};
+            Object.entries(headers).forEach(([key, value]) => {
+                config.headers[key] = value;
+            });
+            return config;
+        },
+        onRejected(error) {
+            return Promise.reject(error);
+        },
+        options: options.axiosInterceptorOptions
+    };
+}

package/es/interceptors/responseBlobInterceptor.d.ts

@@ -0,0 +1,7 @@
+import type { AxiosInterceptorOptions, AxiosResponse } from 'axios';
+import type { ResponseInterceptor } from '../instance';
+export interface ResponseBlobInterceptorOptions {
+    data?: (response: AxiosResponse<any, any>) => any;
+    axiosInterceptorOptions?: AxiosInterceptorOptions;
+}
+export declare function responseBlobInterceptor(options?: ResponseBlobInterceptorOptions): ResponseInterceptor;

package/es/interceptors/responseBlobInterceptor.js

@@ -0,0 +1,15 @@
+export function responseBlobInterceptor(options = {}) {
+    return {
+        onFulfilled(response) {
+            var _a, _b;
+            if (response.request.responseType === 'blob') {
+                return (_b = (_a = options.data) === null || _a === void 0 ? void 0 : _a.call(options, response)) !== null && _b !== void 0 ? _b : response;
+            }
+            return response;
+        },
+        onRejected(error) {
+            return Promise.reject(error);
+        },
+        options: options.axiosInterceptorOptions,
+    };
+}

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>;
@@ -20,6 +21,7 @@ export interface UseAxleOptions<V = any, R = any, P = Record<string, any>> {
     value?: V;
     params?: P | (() => P);
     retry?: number;
+    resetValue?: boolean;
     config?: AxleRequestConfig;
     immediate?: boolean;
     onBefore?(refs: UseAxleRefs<V>): void;

package/es/use.js

@@ -4,7 +4,7 @@ export function createUseAxle(options) {
     const { axle, onTransform: defaultOnTransform } = options;
     const useAxle = (options) => {
         var _a;
-        const { url, method, immediate, value: initialValue, params: initialParamsOrGetter, 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);
@@ -21,13 +21,17 @@ 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 {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@varlet/axle",
-  "version": "0.2.2",
+  "version": "0.2.4-alpha.1701343124078",
   "description": "Progressive request tool based on axios",
   "type": "module",
   "main": "es/index.js",