From 69212ed1daa20e6910ffafae01e60ae67cfea88e Mon Sep 17 00:00:00 2001
From: Jiajun Yan <yanjiajun@ifanr.com>
Date: Wed, 14 Jun 2023 16:19:21 +0800
Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0=E6=96=AD=E7=82=B9=E7=BB=AD?=
 =?UTF-8?q?=E4=BC=A0=E6=8F=8F=E8=BF=B0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 js-sdk/file/file.md | 80 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 80 insertions(+)

diff --git a/js-sdk/file/file.md b/js-sdk/file/file.md
index 51ebbec8..21b96d1e 100644
--- a/js-sdk/file/file.md
+++ b/js-sdk/file/file.md
@@ -202,6 +202,86 @@ HError 对象结构请参考[错误码和 HError 对象](/js-sdk/error-code.md)
 > **info**
 > file 字段可用于含有 file 类型的数据表的数据操作，详细见 [新增数据项](../schema/create-record.md)
 
+## 大文件断点续传
+
+`MyFile.multipartUpload(fileParams, metaData)`
+
+为大文件上传提供断点续传功能。断点续传未完成的文件，会保存 24 小时，超过后，文件会被删除。
+
+> **info**
+> SDK >= 3.23
+
+**fileParams 参数说明（必须）**
+
+| 参数                 |  类型   | 必填 | 说明 |
+| :-------------------| :----- | :--- | :--------- |
+| fileParams.fileObj | String |  Y  | 文件对象（在 Web 端上传时提供该参数）|
+| fileParams.fileName | String | N | 文件名 |
+
+**metaData 参数说明（可选）**
+
+| 参数                   |  类型  | 必填 | 说明 |
+| :---------------------| :----- | :--- | :--- |
+| metaData.categoryID   | String |  N  | 要上传的文件分类 ID |
+| metaData.categoryName | String |  N  | 要上传的文件分类名 |
+| metaData.randomFileLink | String | N | 是否使用随机字符串作为文件的下载地址，不随机可能会覆盖之前的文件，默认为 true |
+
+> **info**
+> 1.请勿同时填写 categoryID 和 categoryName，默认只使用 categoryID
+
+> 2.randomFileLink 举例说明：
+
+> `metaData.randomFileLink` 为 `true` 时，如果 `fileParams.fileName` 为 `avatar.png`，
+> 则返回值中 res.data.file.path 为 `https://cloud-minapp-xxx.cloud.ifanrusercontent.com/1j6ZGvnzSpJ7YBZ8.png`
+
+> `metaData.randomFileLink` 为 `false` 时，如果 `fileParams.fileName` 为 `avatar.png`，
+> 则返回值中 res.data.file.path 为 `https://cloud-minapp-xxx.cloud.ifanrusercontent.com/avatar.png`
+
+**返回参数说明**
+
+res.data:
+
+|   参数  | 类型   | 说明 |
+| :----- | :----- | :-- |
+| status | String | 成功返回 'ok' |
+| path   | String | 上传成功后的访问地址 URL |
+| file   | Object | 包含文件详细信息，详见以下 |
+
+file 参数说明：
+
+| 参数        |  类型  | 说明 |
+| :--------- | :----- | :------ |
+| path       | String | 上传成功后的访问地址 URL |
+| cdn_path   | String | 文件在 CDN 中的相对路径 |
+| created_at | String | 文件上传时间 |
+| id         | Object | 文件 ID |
+| mime_type  | String | 文件媒体类型 |
+| name       | String | 文件名 |
+| size       | Number | 以字节为单位 |
+
+**示例代码**
+
+{% tabs first="Web" %}
+
+{% content "first" %}
+```html
+<input type="file" id="file">
+```
+```javascript
+var f = document.getElementById('file')
+
+f.addEventListener('change', function(e) {
+   let File = new BaaS.File()
+   let fileParams = {fileObj: e.target.files[0]}
+
+   File.multipartUpload(fileParams).then(res => {
+     console.log(res)
+   }, err => {
+   // HError
+   })
+})
+```
+{% endtabs %}
 
 ## 获取文件详情