Version: 3.0.14

Taro.uploadFile(option)

将本地资源上传到服务器。客户端发起一个 HTTPS POST 请求,其中 content-typemultipart/form-data。使用前请注意阅读相关说明

参考文档

类型

(option: Option) => Promise<SuccessCallbackResult & UploadTask> & UploadTask

参数

Option

参数类型必填说明
urlstring开发者服务器地址
filePathstring要上传文件资源的路径
namestring文件对应的 key,开发者在服务端可以通过这个 key 获取文件的二进制内容
headerRecord<string, any>HTTP 请求 Header,Header 中不能设置 Referer
formDataRecord<string, any>HTTP 请求中其他额外的 form data
timeoutnumber超时时间,单位为毫秒
fileNamestring上传的文件名
API 支持度: h5
complete(res: CallbackResult) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: CallbackResult) => void接口调用失败的回调函数
success(result: SuccessCallbackResult) => void接口调用成功的回调函数

API 支持度

API微信小程序H5React Native
Option.fileName✔️

SuccessCallbackResult

参数类型说明
datastring开发者服务器返回的数据
statusCodenumber开发者服务器返回的 HTTP 状态码
errMsgstring调用结果

示例代码

示例 1

Taro.chooseImage({
success (res) {
const tempFilePaths = res.tempFilePaths
Taro.uploadFile({
url: 'https://example.weixin.qq.com/upload', //仅为示例,非真实的接口地址
filePath: tempFilePaths[0],
name: 'file',
formData: {
'user': 'test'
},
success (res){
const data = res.data
//do something
}
})
}
})

示例 2

const uploadTask = Taro.uploadFile({
url: 'https://example.weixin.qq.com/upload', //仅为示例,非真实的接口地址
filePath: tempFilePaths[0],
name: 'file',
formData:{
'user': 'test'
},
success: function (res){
var data = res.data
//do something
}
})
uploadTask.progress((res) => {
console.log('上传进度', res.progress)
console.log('已经上传的数据长度', res.totalBytesSent)
console.log('预期需要上传的数据总长度', res.totalBytesExpectedToSend)
})
uploadTask.abort() // 取消上传任务

API 支持度

API微信小程序百度小程序支付宝小程序H5React Native
Taro.uploadFile✔️✔️✔️✔️