request.d.ts 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. // request.js 的 TypeScript 声明文件
  2. export interface ApiResponse<T = any> {
  3. code: number
  4. msg: string
  5. data: T
  6. rows?: T[]
  7. total?: number
  8. }
  9. export interface RequestOptions {
  10. url: string
  11. method?: 'GET' | 'POST' | 'PUT' | 'DELETE'
  12. data?: any
  13. header?: Record<string, any>
  14. timeout?: number
  15. clientId?: string
  16. responseType?: 'text' | 'json' | 'arraybuffer' | 'blob'
  17. }
  18. export interface LoginData {
  19. username: string
  20. password: string
  21. tenantId?: string
  22. clientId?: string
  23. grantType?: string
  24. }
  25. export interface UploadResponse {
  26. code: number
  27. msg: string
  28. data: {
  29. url: string
  30. ossId: string
  31. fileName: string
  32. }
  33. }
  34. export interface DownloadResponse {
  35. statusCode: number
  36. tempFilePath: string
  37. errMsg: string
  38. }
  39. // 主要导出函数
  40. export function request(options: RequestOptions): Promise<ApiResponse>
  41. // 便捷请求方法
  42. export function get<T = any>(url: string, data?: any, header?: Record<string, any>): Promise<ApiResponse<T>>
  43. export function post<T = any>(url: string, data?: any, header?: Record<string, any>): Promise<ApiResponse<T>>
  44. export function put<T = any>(url: string, data?: any, header?: Record<string, any>): Promise<ApiResponse<T>>
  45. export function del<T = any>(url: string, data?: any, header?: Record<string, any>): Promise<ApiResponse<T>>
  46. // 文件操作方法
  47. export function uploadFile(url: string, filePath: string, formData?: Record<string, any>): Promise<UploadResponse>
  48. export function downloadFile(url: string): Promise<DownloadResponse>
  49. export function download(url: string, params: any, fileName: string): Promise<any>
  50. // API对象
  51. export const api: {
  52. login: (data: LoginData) => Promise<ApiResponse>
  53. getUserInfo: () => Promise<ApiResponse>
  54. getTenantList: (isToken?: boolean) => Promise<ApiResponse>
  55. logout: () => Promise<ApiResponse>
  56. }