import type {
|
AxiosRequestConfig,
|
AxiosResponse,
|
CreateAxiosDefaults,
|
InternalAxiosRequestConfig,
|
} from 'axios';
|
|
type ExtendOptions<T = any> = {
|
/**
|
* 参数序列化方式。预置的有
|
* - brackets: ids[]=1&ids[]=2&ids[]=3
|
* - comma: ids=1,2,3
|
* - indices: ids[0]=1&ids[1]=2&ids[2]=3
|
* - repeat: ids=1&ids=2&ids=3
|
*/
|
paramsSerializer?:
|
| 'brackets'
|
| 'comma'
|
| 'indices'
|
| 'repeat'
|
| AxiosRequestConfig<T>['paramsSerializer'];
|
/**
|
* 响应数据的返回方式。
|
* - raw: 原始的AxiosResponse，包括headers、status等，不做是否成功请求的检查。
|
* - body: 返回响应数据的BODY部分（只会根据status检查请求是否成功，忽略对code的判断，这种情况下应由调用方检查请求是否成功）。
|
* - data: 解构响应的BODY数据，只返回其中的data节点数据（会检查status和code是否为成功状态）。
|
*/
|
responseReturn?: 'body' | 'data' | 'raw';
|
};
|
type RequestClientConfig<T = any> = AxiosRequestConfig<T> & ExtendOptions<T>;
|
|
type RequestResponse<T = any> = AxiosResponse<T> & {
|
config: RequestClientConfig<T>;
|
};
|
|
type RequestContentType =
|
| 'application/json;charset=utf-8'
|
| 'application/octet-stream;charset=utf-8'
|
| 'application/x-www-form-urlencoded;charset=utf-8'
|
| 'multipart/form-data;charset=utf-8';
|
|
type RequestClientOptions = CreateAxiosDefaults & ExtendOptions;
|
|
/**
|
* SSE 请求选项
|
*/
|
interface SseRequestOptions extends RequestInit {
|
onMessage?: (message: string) => void;
|
onEnd?: () => void;
|
}
|
|
interface RequestInterceptorConfig {
|
fulfilled?: (
|
config: ExtendOptions & InternalAxiosRequestConfig,
|
) =>
|
| (ExtendOptions & InternalAxiosRequestConfig<any>)
|
| Promise<ExtendOptions & InternalAxiosRequestConfig<any>>;
|
rejected?: (error: any) => any;
|
}
|
|
interface ResponseInterceptorConfig<T = any> {
|
fulfilled?: (
|
response: RequestResponse<T>,
|
) => Promise<RequestResponse> | RequestResponse;
|
rejected?: (error: any) => any;
|
}
|
|
type MakeErrorMessageFn = (message: string, error: any) => void;
|
|
interface HttpResponse<T = any> {
|
/**
|
* 0 表示成功 其他表示失败
|
* 0 means success, others means fail
|
*/
|
code: number;
|
data: T;
|
msg: string;
|
}
|
|
interface PageParam {
|
[key: string]: any;
|
pageNo: number;
|
pageSize: number;
|
}
|
|
interface PageResult<T> {
|
list: T[];
|
total: number;
|
}
|
|
export type {
|
HttpResponse,
|
MakeErrorMessageFn,
|
PageParam,
|
PageResult,
|
RequestClientConfig,
|
RequestClientOptions,
|
RequestContentType,
|
RequestInterceptorConfig,
|
RequestResponse,
|
ResponseInterceptorConfig,
|
SseRequestOptions,
|
};
|
