TanTan
e311ca3275
Build NapCat Artifacts / Windows Loader Test (push) Canceled after 0s
Build NapCat Artifacts / Type Check & Test (push) Canceled after 0s
Build NapCat Artifacts / Build NapCat.Framework (push) Canceled after 0s
Build NapCat Artifacts / Build NapCat.Shell (push) Canceled after 0s
74 lines
2.7 KiB
Plaintext
74 lines
2.7 KiB
Plaintext
import type { DependencyList } from 'react';
|
|
import type Fetch from './Fetch';
|
|
import type { CachedData } from './utils/cache';
|
|
export type Service<TData, TParams extends any[]> = (...args: TParams) => Promise<TData>;
|
|
export type Subscribe = () => void;
|
|
export interface FetchState<TData, TParams extends any[]> {
|
|
loading: boolean;
|
|
params?: TParams;
|
|
data?: TData;
|
|
error?: Error;
|
|
}
|
|
export interface PluginReturn<TData, TParams extends any[]> {
|
|
onBefore?: (params: TParams) => ({
|
|
stopNow?: boolean;
|
|
returnNow?: boolean;
|
|
} & Partial<FetchState<TData, TParams>>) | void;
|
|
onRequest?: (service: Service<TData, TParams>, params: TParams) => {
|
|
servicePromise?: Promise<TData>;
|
|
};
|
|
onSuccess?: (data: TData, params: TParams) => void;
|
|
onError?: (e: Error, params: TParams) => void;
|
|
onFinally?: (params: TParams, data?: TData, e?: Error) => void;
|
|
onCancel?: () => void;
|
|
onMutate?: (data: TData) => void;
|
|
}
|
|
export interface Options<TData, TParams extends any[]> {
|
|
manual?: boolean;
|
|
onBefore?: (params: TParams) => void;
|
|
onSuccess?: (data: TData, params: TParams) => void;
|
|
onError?: (e: Error, params: TParams) => void;
|
|
onFinally?: (params: TParams, data?: TData, e?: Error) => void;
|
|
defaultParams?: TParams;
|
|
refreshDeps?: DependencyList;
|
|
refreshDepsAction?: () => void;
|
|
loadingDelay?: number;
|
|
pollingInterval?: number;
|
|
pollingWhenHidden?: boolean;
|
|
pollingErrorRetryCount?: number;
|
|
refreshOnWindowFocus?: boolean;
|
|
focusTimespan?: number;
|
|
debounceWait?: number;
|
|
debounceLeading?: boolean;
|
|
debounceTrailing?: boolean;
|
|
debounceMaxWait?: number;
|
|
throttleWait?: number;
|
|
throttleLeading?: boolean;
|
|
throttleTrailing?: boolean;
|
|
cacheKey?: string;
|
|
cacheTime?: number;
|
|
staleTime?: number;
|
|
setCache?: (data: CachedData<TData, TParams>) => void;
|
|
getCache?: (params: TParams) => CachedData<TData, TParams> | undefined;
|
|
retryCount?: number;
|
|
retryInterval?: number;
|
|
ready?: boolean;
|
|
}
|
|
export type Plugin<TData, TParams extends any[]> = {
|
|
(fetchInstance: Fetch<TData, TParams>, options: Options<TData, TParams>): PluginReturn<TData, TParams>;
|
|
onInit?: (options: Options<TData, TParams>) => Partial<FetchState<TData, TParams>>;
|
|
};
|
|
export interface Result<TData, TParams extends any[]> {
|
|
loading: boolean;
|
|
data?: TData;
|
|
error?: Error;
|
|
params: TParams | [];
|
|
cancel: Fetch<TData, TParams>['cancel'];
|
|
refresh: Fetch<TData, TParams>['refresh'];
|
|
refreshAsync: Fetch<TData, TParams>['refreshAsync'];
|
|
run: Fetch<TData, TParams>['run'];
|
|
runAsync: Fetch<TData, TParams>['runAsync'];
|
|
mutate: Fetch<TData, TParams>['mutate'];
|
|
}
|
|
export type Timeout = ReturnType<typeof setTimeout>;
|