---
name: "uploadFile"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "2.0.1" }
  - { name: "@ray-js/ray", version: "0.6.5" }
platform:
  - "iOS"
  - "Android"
async: true
title: "p2p.uploadFile - P2P 上传文件"
---

## uploadFile

> [VERSION] BaseKit >= 2.0.1 | @ray-js/ray >= 0.6.5

> [PLATFORM] iOS, Android

> ⚡ **支持 Promise 调用** — 不传 success / fail / complete 回调时，该方法返回 Promise。

### 描述

将本地资源上传到服务器。客户端发起一个 HTTPS POST 请求，其中 content-type 为 multipart/form-data

### 参数

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `url` | `string` | 是 | - | `2.0.1` | 开发者服务器地址 |
| `filePath` | `string` | 是 | - | `2.0.1` | 要上传文件资源的路径 (本地路径) |
| `name` | `string` | 是 | - | `2.0.1` | 文件对应的 key，开发者在服务端可以通过这个 key 获取文件的二进制内容 |
| `header` | `Record<string, string>` | 否 | - | `2.0.1` | HTTP 请求的 Header，Header 中不能设置 Referer |
| `formData` | `Record<string, string>` | 否 | - | `2.0.1` | HTTP 请求中其他额外的 form data |
| `timeout` | `number` | 否 | - | `2.0.1` | 超时时间，单位为毫秒 |
| `method` | `"POST" \| "PUT"` | 否 | `'POST'` | `3.23.0` | 上传的 HTTP 请求方式，默认 POST |
| `complete` | `() => void` | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用失败的回调函数 |

#### success 回调参数

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `data` | `string` | `3.2.6` | 开发者服务器返回的数据 |
| `statusCode` | `number` | `3.2.6` | 开发者服务器返回的 HTTP 状态码 |

#### fail 回调参数

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorMsg` | `string` | 错误信息 |
| `errorCode` | `string \| number` | 错误码 |
| `innerError` | `Object` | 错误扩展 |

##### fail(params).innerError 的属性

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorCode` | `string \| number` | 错误扩展码 |
| `errorMsg` | `string` | 错误扩展信息 |


### 合法值

##### `method` 合法值

| 值 | 说明 |
| --- | --- |
| `"POST"` | HTTP POST 请求 |
| `"PUT"` | HTTP PUT 请求 |


### 示例代码

#### Demo

```tsx
import { downloadFile, uploadFile } from '@ray-js/ray'

// 上传本地文件：先下载一个文件拿到本地路径，再 uploadFile 上传到服务器，返回 UploadTask
downloadFile({
  url: "https://airtake-public-data-1254153901.cos.ap-shanghai.myqcloud.com/ttttestfile/test_image.jpg",
  success: ({ tempFilePath }) => {
    const task = uploadFile({
      url: "https://httpbin.org/post",
      filePath: tempFilePath,
      name: "file",
      success: data => console.log("上传完成，状态码：", data.statusCode),
      fail: error => console.error("上传失败：", JSON.stringify(error)),
    });
    console.log("uploadTask 已创建");
  },
  fail: error => console.error(error),
});
```