axios.d.ts 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. /*
  2. * @Author: sjl
  3. * @Date: 2023-05-07 20:34:09
  4. * @Descripttion:
  5. */
  6. export type ErrorMessageMode = 'none' | 'modal' | 'message' | undefined;
  7. export interface RequestOptions {
  8. // Splicing request parameters to url
  9. joinParamsToUrl?: boolean;
  10. // Format request parameter time
  11. formatDate?: boolean;
  12. // Whether to process the request result
  13. isTransformResponse?: boolean;
  14. // Whether to return native response headers
  15. // For example: use this attribute when you need to get the response headers
  16. isReturnNativeResponse?: boolean;
  17. // Whether to join url
  18. joinPrefix?: boolean;
  19. // Interface address, use the default apiUrl if you leave it blank
  20. apiUrl?: string;
  21. ligongApiUrl?: string;
  22. // Error message prompt type
  23. errorMessageMode?: ErrorMessageMode;
  24. // Whether to add a timestamp
  25. joinTime?: boolean;
  26. ignoreCancelToken?: boolean;
  27. // Whether to send token in header
  28. withToken?: boolean;
  29. }
  30. export interface Result<T = any> {
  31. code: number;
  32. type: 'success' | 'error' | 'warning';
  33. message: string;
  34. result: T;
  35. }
  36. // multipart/form-data: upload file
  37. export interface UploadFileParams {
  38. // Other parameters
  39. data?: Recordable;
  40. // File parameter interface field name
  41. name?: string;
  42. // file name
  43. file: File | Blob;
  44. // file name
  45. filename?: string;
  46. [key: string]: any;
  47. }
  48. export interface PaginationResult<T = Recordable> {
  49. items: T[];
  50. total: number;
  51. }