vue-vben-admin/types/axios.d.ts

54 lines
1.4 KiB
TypeScript
Raw Normal View History

export type ErrorMessageMode = 'none' | 'modal' | 'message' | undefined
2020-09-28 20:19:10 +08:00
export interface RequestOptions {
2021-02-26 22:45:36 +08:00
// Splicing request parameters to url
joinParamsToUrl?: boolean
2021-02-26 22:45:36 +08:00
// Format request parameter time
formatDate?: boolean
2021-06-26 00:31:21 +08:00
// Whether to process the request result
isTransformResponse?: boolean
2021-06-26 00:31:21 +08:00
// Whether to return native response headers
// For example: use this attribute when you need to get the response headers
isReturnNativeResponse?: boolean
2021-02-26 22:45:36 +08:00
// Whether to join url
joinPrefix?: boolean
2021-02-26 22:45:36 +08:00
// Interface address, use the default apiUrl if you leave it blank
apiUrl?: string
// 请求拼接路径
urlPrefix?: string
2021-02-26 22:45:36 +08:00
// Error message prompt type
errorMessageMode?: ErrorMessageMode
2021-02-26 22:45:36 +08:00
// Whether to add a timestamp
joinTime?: boolean
ignoreCancelToken?: boolean
// Whether to send token in header
withToken?: boolean
2022-03-19 00:07:34 +08:00
// 请求重试机制
retryRequest?: RetryRequest
2020-09-28 20:19:10 +08:00
}
2022-03-19 00:07:34 +08:00
export interface RetryRequest {
isOpenRetry: boolean
count: number
waitTime: number
2022-03-19 00:07:34 +08:00
}
2020-09-28 20:19:10 +08:00
export interface Result<T = any> {
code: number
type: 'success' | 'error' | 'warning'
message: string
result: T
2020-09-28 20:19:10 +08:00
}
2021-02-26 22:45:36 +08:00
// multipart/form-data: upload file
2020-11-12 00:06:12 +08:00
export interface UploadFileParams {
2021-02-26 22:45:36 +08:00
// Other parameters
data?: Recordable
2021-02-26 22:45:36 +08:00
// File parameter interface field name
name?: string
2021-02-26 22:45:36 +08:00
// file name
file: File | Blob
2021-02-26 22:45:36 +08:00
// file name
filename?: string
[key: string]: any
2020-11-12 00:06:12 +08:00
}