Skip to content

k.file/resumable ​

断点续传

概述 ​

k.file.resumableUpload 提供大文件分片上传功能,支持断点续传。

create() ​

创建断点续传任务。

ts
k.api.post("create", () => {
    const task = k.file.resumableUpload.create("video.mp4", 10 * 1024 * 1024, 1024 * 1024)
    return {
        id: task.id,
        name: task.name,
        size: task.size,
        requireChunks: task.requireChunks
    }
})

参数:

参数类型必填说明
namestring是文件名
sizenumber是文件大小(字节)
chunkSizenumber否分块大小,默认 1024 * 1024

返回: ResumableUploadTask

get() ​

获取断点续传任务。

ts
k.api.post("get", () => {
    const task = k.file.resumableUpload.create("video.mp4", 1024 * 1024, 256 * 1024)
    const retrieved = k.file.resumableUpload.get(task.id)
    return { id: retrieved.id, name: retrieved.name }
})

参数:

参数类型必填说明
idstring是任务 ID

返回: ResumableUploadTask

remove() ​

删除断点续传任务。

ts
k.api.post("remove", () => {
    const task = k.file.resumableUpload.create("video.mp4", 1024 * 1024, 256 * 1024)
    k.file.resumableUpload.remove(task.id)
    const retrieved = k.file.resumableUpload.get(task.id)
    return { removed: !retrieved }
})

参数:

参数类型必填说明
idstring是任务 ID

返回: void

ResumableUploadTask ​

断点续传任务对象。

属性 ​

属性说明类型
id任务 IDstring
name文件名string
size文件大小number
chunkSize分块大小number
requireChunks需要的分块索引列表number[]
timestamp时间戳number

build() ​

从所有分块构建文件。

ts
k.api.post("build", () => {
    const task = k.file.resumableUpload.get(taskId)
    const fileInfo = task.build("final-video.mp4")
    return fileInfo
})

参数:

参数类型必填说明
fileNamestring否新文件名,默认使用原任务名

返回: FileInfo

saveChunk() ​

保存分块数据。

ts
k.api.post("saveChunk", () => {
    const task = k.file.resumableUpload.get(taskId)
    task.saveChunk(chunkData, chunkIndex)
    return { saved: true }
})

参数:

参数类型必填说明
bytesnumber[]是分块数据
chunknumber是分块索引

返回: void

相关文档 ​