npm.io
1.19.3 • Published 5 years ago

nos-uploader

Licence
Version
1.19.3
Deps
2
Size
44 kB
Vulns
0
Weekly
0

nos-uploader

文件上传组件

文档

https://github.com/NetEase-Object-Storage/nos-javascript-sdk

QA

为什么不直接用nos-javascript-sdk?

  1. 该组件不支持https协议上传
  2. nos-javascript-sdk依赖jQuery,并且不是esm格式的

为什么不用其他组件比如http://fex.baidu.com/webuploader/

  1. nos那边单个文件最大100MB,如果超过100MB则需要分块上传,用其他组件分块上传会有问题

安装

$ yarn add nos-uploader

API

Classes

NosUploader

NosUploader

Functions

addFile(file, callback)void

添加文件

getFile(fileKey)Obejct

根据fileKey获取指定文件对象

getDNS(bucketname, callback)void

查询DNS

getOffset(param, callback)void

获取上传断点位置

uploadTrunk(param, trunkData, callback)void

上传分片

pauseUpload()void

暂停上传

NosUploader

NosUploader

Kind: global class

addFile(file, callback) ⇒ void

添加文件

Kind: global function

Param Type Description
file Element 需要上传的文件
callback function 成功回调函数 回调函数中的参数包括: fileObj: 文件对象 文件对象中包含的属性: fileKey {String} 文件名与文件大小的MD5值 file {File} 文件对象 fileName {String} 文件名 status {Number} 文件状态( 0 未上传 1 正在上传 2 已上传) progress {Number} 上传进度(保留两位小数的百分比)

getFile(fileKey) ⇒ Obejct

根据fileKey获取指定文件对象

Kind: global function
Returns: Obejct - 文件对象

Param Type Description
fileKey String 文件名和文件大小md5值

getDNS(bucketname, callback) ⇒ void

查询DNS

Kind: global function

Param Type Description
bucketname Object 桶名
callback function 成功回调函数 回调函数参数包括: upload: 返回最优的边缘节点列表,加速效果最好的在前面 lbs: 返回的最优的DNS地址,后续可以使用该地址进行上传

getOffset(param, callback) ⇒ void

获取上传断点位置

Kind: global function

Param Type Description
param Object AJAX参数 param属性有: serveIp {String} IP地址 fileKey {String} 文件名与文件大小的MD5值 bucketName {String} 桶名 objectName {String} 对象名 token {String} 上传凭证
callback function 获取成功回调 回调函数中的参数: offset {long} 当前分片在整个对象中的起始偏移量

uploadTrunk(param, trunkData, callback) ⇒ void

上传分片

Kind: global function

Param Type Description
param Object AJAX参数 param中的属性有: serveIp {String} IP地址 bucketName {String} 桶名 objectName {String} 对象名 token {String} 上传凭证
trunkData Object 分片数据 trunkData属性有: file {File} File对象 fileKey {String} 文件名和文件大小的MD5值 offset {long} 当前分片在整个对象中的起始偏移量 trunkSize {long} 分片大小 trunkEnd {long} 分片结束位置 context: {String} 上传上下文
callback function 文件(非分片)上传成功回调函数 回调函数参数: trunkData {Object} 分片数据

pauseUpload() ⇒ void

暂停上传

Kind: global function