# Interface: UploadFileParams ‹Err›
• UploadFileParams‹Err›()
# Type parameters:
▪ Err: MogsRes
# Type parameters
▪ Err: MogsRes
# Properties
# filePath
• filePath: string
要上传文件资源的路径 (本地路径)
Returns: string
# Optional
formData
• formData? : Record‹string, unknown›
HTTP 请求中其他额外的 form data
Returns: Record‹string, unknown›
# Optional
header
• header? : Record‹string, unknown›
HTTP 请求 Header,Header 中不能设置 Referer
Returns: Record‹string, unknown›
# name
• name: string
文件对应的 key,开发者在服务端可以通过这个 key 获取文件的二进制内容
Returns: string
# Optional
timeout
• timeout? : number
超时时间,单位为毫秒
Returns: number
# url
• url: string
开发者服务器地址
Returns: string
# Methods
# Optional
complete
▸ complete(res
: UploadFileRes | Err): void
Inherited from MogsParams.complete
接口调用结束的回调函数(调用成功、失败都会执行)
# 参数:
属性 | 类型 |
---|---|
res | UploadFileRes | Err |
# 返回值:
void
# Optional
fail
▸ fail(err
: Err): void
Inherited from MogsParams.fail
接口调用失败的回调函数
# 参数:
属性 | 类型 |
---|---|
err | Err |
# 返回值:
void
# Optional
success
▸ success(res
: UploadFileRes): void
Inherited from MogsParams.success
接口调用成功的回调函数
# 参数:
属性 | 类型 |
---|---|
res | UploadFileRes |
UploadFileRes
属性 | 类型 | 描述 |
---|---|---|
data | string | 开发者服务器返回的数据 |
errMsg | string | API 调用成功/失败的消息 |
statusCode | number | 开发者服务器返回的 HTTP 状态码 |
# 返回值:
void
← UploadFileRes KVData →