跳到主要内容
版本:4.x

Taro.uploadFile(option)

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

支持情况:

参考文档

类型

(option: Option) => UploadTaskPromise

参数

参数类型
optionOption

Option

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

SuccessCallbackResult

参数类型必填说明
datastring开发者服务器返回的数据
statusCodenumber开发者服务器返回的 HTTP 状态码
errMsgstring调用结果
headerTaroGeneral.IAnyObject开发者服务器返回的 HTTP Response Header
API 支持度: weapp
weapp: 非官方文档标注属性
cookiesstring[]cookies
API 支持度: weapp
weapp: 非官方文档标注属性

示例代码

示例 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() // 取消上传任务