Skip to content

2.x 升级到 3.x 文档注意事项

winddies edited this page Nov 20, 2020 · 13 revisions

2.x 与 3.x 的上传接口形式并没有发生变化,但是内在的的上传 API 已经更新,可以提供更快速的上传体验。

文件目录改变

  • 对原有的 upload.js 文件进行了拆分,在 upload 文件夹下拆分成 base.ts、index.ts、direct.ts、resume.ts,这里主要是按功能进行结构拆分 。
  • api 请求从 utils 文件抽离,统一放在 api.ts 。

新增功能限制

  • 上传分片数量最大不能超过 10000
  • 可以设置分片大小,但是每片大小不能超过 1G

对外新增 feature

  • typescript 的支持,你可以在你的项目中获取 js-sdk 的类型定义
  • 新增 deleteUploadedChunk,可以删除已上传完成的 chunk
  • next 的数据增加了 uploadInfo 字段
  • config 增加 chunkSize,用户可以设置分片大小
  • putExtra 增加了 metadata 参数,用户可以自定义设置文件元信息

2.x 升级到 3.x 的一些 breaking change

  • 由于上传 API 的变更及部分冗余接口整理,删除了部分对外接口:
    • filterParams:用于过滤掉 putExtraparams 里不符合自定义变量规则的变量。
    • createMkFileUrl:返回创建文件的 url,因为 2.x 中创建文件的接口构造比较复杂,所以当时把这个暴露了出去。在更新新上传 API 后考虑到在实际使用中应该提倡用户使用 sdk,并且因为新 API 里的接口形式单一,所以这里就不对外暴露了。
    • getHeadersForMkFile:与 createMkFileUrl 配合使用,因为 createMkFileUrl 删除,所以这里也不再保留。
    • getResumeUploadedSize:返回已上传的 chunk 大小。实际使用中用户不需要去关心已上传的 chunk,所以这里删除。
  • putExtra 参数改变
    • mimeType 含义改变,之前代表的是允许上传的文件类型数组,现在代表的是用户所设置的文件类型
    • customVars 代替原有的 params
Clone this wiki locally