import { MaybeRefOrGetter, Ref, WatchSource } from 'vue'; import { Fetch } from './Fetch'; export type Service = (...args: Params) => Promise; type SingleWatchSource = WatchSource | object; type MultiWatchSources = (WatchSource | object)[]; export interface FetchState { loading: boolean; params?: Params; data?: Data; error?: Error; } export interface Options { manual?: boolean; onBefore?: (params: Params) => void; onSuccess?: (data: Data, params: Params) => void; onError?: (e: Error, params: Params) => void; onFinally?: (params: Params, data?: Data, e?: Error) => void; refreshDeps?: SingleWatchSource | MultiWatchSources; refreshDepsAction?: () => void; loadingDelay?: MaybeRefOrGetter; pollingInterval?: MaybeRefOrGetter; pollingWhenHidden?: MaybeRefOrGetter; pollingErrorRetryCount?: MaybeRefOrGetter; refreshOnWindowFocus?: MaybeRefOrGetter; focusTimespan?: MaybeRefOrGetter; debounceWait?: MaybeRefOrGetter; debounceLeading?: MaybeRefOrGetter; debounceTrailing?: MaybeRefOrGetter; debounceMaxWait?: MaybeRefOrGetter; throttleWait?: MaybeRefOrGetter; throttleLeading?: MaybeRefOrGetter; throttleTrailing?: MaybeRefOrGetter; retryCount?: MaybeRefOrGetter; retryInterval?: MaybeRefOrGetter; } export interface Plugin { (fetchInstance: Fetch, options: Options): PluginReturn; onInit?: (options: Options) => Partial>; } export interface PluginReturn { onBefore?: (params: Params) => ({ stopNow?: boolean; returnNow?: boolean; } & Partial>) | void; onRequest?: (service: Service, params: Params) => { servicePromise?: Promise; }; onSuccess?: (data: Data, params: Params) => void; onError?: (e: Error, params: Params) => void; onFinally?: (params: Params, data?: Data, e?: Error) => void; onCancel?: () => void; onMutate?: (data: Data) => void; } export interface Result { data: Ref; error: Ref; params: Ref; loading: Ref; run: Fetch['run']; mutate: Fetch['mutate']; cancel: Fetch['cancel']; refresh: Fetch['refresh']; runAsync: Fetch['runAsync']; refreshAsync: Fetch['refreshAsync']; } export {};