vue3-request 1.0.14 → 1.0.16

package/dist/vue3-request.es.d.ts

@@ -1,8 +1,110 @@
-import { Plugin as Plugin_2 } from './types';
-import { useRequest } from './useRequest';
+import { Reactive } from 'vue';
+import { Ref } from 'vue';
+import { ToRefs } from 'vue';
 
+export declare type CacheCallbackType<D = any, P = any> = ({ data, params, time, }: CacheParamsType<D, P>) => void;
+
+export declare type CacheParamsType<D = any, P = any> = {
+    data: D;
+    params: P;
+    time: number;
+};
+
+export declare type CallbackType<D = any, P extends any[] = any> = (signal?: AbortSignal) => ServiceType<D, P>;
+
+declare type DebounceOptionsType = {
+    leading?: boolean;
+    trailing?: boolean;
+};
+
+export declare type IOptions<D, P extends any[]> = Partial<{
+    onBefore: (params: P) => void;
+    onSuccess: (data: D, params: P) => void;
+    onFinally: (params: P, data: D, error: Error) => void;
+    onError: (error: Error, params: P) => void;
+    manual: boolean;
+    defaultParams: P;
+    refreshDeps: (Ref<any> | Reactive<any>)[];
+    refreshDepsAction: () => void;
+    pollingInterval: number | Ref<number>;
+    errorRetryCount: number | Ref<number>;
+    errorRetryInterval: number | Ref<number>;
+    refreshOnWindowFocus: boolean;
+    refocusTimespan: number;
+    cacheKey: string;
+    cacheTime: number;
+    staleTime: number;
+    ready: Ref<boolean> | (() => boolean);
+    debounceWait: Ref<number> | number;
+    debounceOptions: Reactive<DebounceOptionsType> | DebounceOptionsType;
+    throttleWait: Ref<number> | number;
+    throttleOptions: Reactive<ThrottleOptionsType> | ThrottleOptionsType;
+}>;
+
+export declare interface IState<D, P extends any[]> {
+    data: D | undefined;
+    isLoading: boolean;
+    isFinished: boolean;
+    isAborted: boolean;
+    error: Error | undefined;
+    params: P;
+}
+
+declare type Plugin_2<D = any, P extends any[] = any> = (requestInstance: Request_2<D, P>, options: IOptions<D, P>) => PluginReturn<D, P>;
 export { Plugin_2 as Plugin }
 
-export { useRequest }
+export declare type PluginMethodsReturn<D, P extends any[]> = Partial<{
+    servicePromise?: ReturnType<ServiceType<D, P>>;
+    signal?: AbortSignal;
+    isStaleTime?: boolean;
+    isReady?: boolean;
+}>;
+
+export declare type PluginReturn<D, P extends any[]> = Partial<{
+    onBefore: (params: P) => void;
+    onSuccess: (data: D, params: P) => void;
+    onFinally: (params: P, data: D, error: Error) => void;
+    onError: (error: Error, params: P) => void;
+    onCancel: () => void;
+    onRequest: (service: ServiceType<D, P>) => ServiceType<D, P>;
+}>;
+
+declare class Request_2<D, P extends any[]> {
+    service: CallbackType<D, P>;
+    options?: IOptions<D, P>;
+    currentRequestId: number;
+    pluginImpls: PluginReturn<D, P>[];
+    state: IState<D, P>;
+    abort: () => void;
+    constructor(service: CallbackType<D, P>, options?: IOptions<D, P>);
+    setState: (s: Partial<IState<D, P>>) => void;
+    executePlugin: (event: keyof PluginReturn<D, P>, ...rest: any[]) => PluginMethodsReturn<D, P>;
+    loading: (isLoading: boolean) => void;
+    onFinished: () => void;
+    runAsync: (...params: P) => Promise<D>;
+    run: (...params: P) => void;
+    refresh: () => void;
+    refreshAsync: () => Promise<D>;
+    cancel: () => void;
+}
+
+export declare type ServiceType<D = any, P extends any[] = any> = (...args: P) => Promise<D>;
+
+declare type ThrottleOptionsType = {
+    leading?: boolean;
+    trailing?: boolean;
+};
+
+export declare function useRequest<D, P extends any[]>(service: CallbackType<D, P>, options?: IOptions<D, P>, plugins?: Plugin_2<D, P>[]): UseRequestReturnType<D, P>;
+
+export declare interface UseRequestReturnType<D, P extends any[]> extends ToRefs<IState<D, P>> {
+    run: (...args: P) => void;
+    cancel: () => void;
+    refresh: () => void;
+    runAsync: (...args: P) => Promise<D>;
+    abort: () => void;
+    refreshAsync: () => Promise<D>;
+    clearCache: () => void;
+}
 
 export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vue3-request",
-  "version": "1.0.14",
+  "version": "1.0.16",
   "type": "module",
   "description": "A Vue3 asynchronous request processing library, designed to simplify your asynchronous operations and API calls.",
   "main": "dist/vue3-request.es.js",