axios.d.ts 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. export type ErrorMessageMode = 'none' | 'modal' | 'message' | undefined;
  2. export type SuccessMessageMode = 'none' | 'success' | 'error' | undefined;
  3. export interface RequestOptions {
  4. // 将请求参数拼接到url
  5. joinParamsToUrl?: boolean;
  6. // 格式化请求参数时间
  7. formatDate?: boolean;
  8. // 是否处理请求结果
  9. isTransformResponse?: boolean;
  10. // 是否返回本地响应头,需要获取响应头时使用此属性
  11. isReturnNativeResponse?: boolean;
  12. // 默认将prefix 添加到url
  13. joinPrefix?: boolean;
  14. // 接口地址,如果保留为空,则使用默认值
  15. apiUrl?: string;
  16. // 请求拼接路径
  17. urlPrefix?: string;
  18. // 错误消息提示类型
  19. errorMessageMode?: ErrorMessageMode;
  20. // 成功消息提示类型
  21. successMessageMode?: SuccessMessageMode;
  22. // 是否添加时间戳
  23. joinTime?: boolean;
  24. ignoreCancelToken?: boolean;
  25. //是否在标头中发送令牌
  26. withToken?: boolean;
  27. }
  28. export interface Result<T = any> {
  29. code: number;
  30. type: 'success' | 'error' | 'warning';
  31. message: string;
  32. result: T;
  33. }
  34. //文件上传参数
  35. export interface UploadFileParams {
  36. // 其他参数
  37. data?: Recordable;
  38. // 文件参数接口字段名
  39. name?: string;
  40. // 文件
  41. file: File | Blob;
  42. // 文件名
  43. filename?: string;
  44. [key: string]: any;
  45. }
  46. //文件返回参数
  47. export interface UploadFileCallBack {
  48. // 成功回调方法
  49. success?: any;
  50. // 是否返回响应头,需要获取响应头时使用此属性
  51. isReturnResponse?: boolean;
  52. }