以Promise风格调用: 不支持。
将本地资源上传到服务器。客户端发起一个 HTTPS POST 请求,其中 content-type 为 multipart/form-data。
属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| url | string | 是 | 开发者服务器地址 | |
| filePath | string | 是 | 要上传文件资源的路径 (本地路径) | |
| name | string | 是 | 文件对应的 key,开发者在服务端可以通过这个 key 获取文件的二进制内容 | |
| header | object | 否 | HTTP 请求 Header,Header 中不能设置 Referer | |
| formData | object | 否 | HTTP 请求中其他额外的 form data | |
| timeout | number | 否 | 超时时间,单位为毫秒 | |
| success | function | 否 | 接口调用成功的回调函数 | |
| fail | function | 否 | 接口调用失败的回调函数 | |
| complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
属性 | 类型 | 说明 |
|---|---|---|
| data | string,object | 开发者服务器返回的数据 |
| statusCode | number | 开发者服务器返回的 HTTP 状态码 |
| errMsg | string |
属性 | 类型 | 说明 |
|---|---|---|
| code | number | |
| data | object | |
| msg | string |
// 调用 uploadFile 上传文件
xhs.uploadFile({
url: 'https://example.com/upload', // 开发者服务器地址
filePath: '/path/to/local/file.jpg', // 本地文件路径
name: 'file', // 文件对应的 key
header: {
'Content-Type': 'multipart/form-data'
},
formData: {
userId: '12345', // 额外的表单数据
description: '这是一个测试文件'
},
timeout: 10000, // 超时时间,单位为毫秒
success: (res) => {
console.log('上传成功:', res);
console.log('服务器返回的数据:', res.data);
console.log('HTTP 状态码:', res.statusCode);
},
fail: (err) => {
console.error('上传失败:', err.errMsg);
},
complete: () => {
console.log('uploadFile 调用结束');
}
});