options支持的配置项:
target
目标上传 URL,可以是字符串也可以是函数,如果是函数的话,则会传入Uploader.File
实例、当前块Uploader.Chunk
以及是否是测试模式,默认值为'/'
。singleFile
单文件上传。覆盖式,如果选择了多个会把之前的取消掉。默认false
。chunkSize
分块时按照该值来分。最后一个上传块的大小是可能是大于等于1倍的这个值但是小于两倍的这个值大小,默认1*1024*1024
。forceChunkSize
是否强制所有的块都是小于等于chunkSize
的值。默认是false
。simultaneousUploads
并发上传数,默认3
。fileParameterName
上传文件时文件的参数名,默认file
。query
其他额外的参数,这个可以是一个对象或者是一个函数,如果是函数的话,则会传入Uploader.File
实例、当前块Uploader.Chunk
以及是否是测试模式,默认为{}
。headers
额外的一些请求头,如果是函数的话,则会传入Uploader.File
实例、当前块Uploader.Chunk
以及是否是测试模式,默认{}
。withCredentials
标准的 CORS 请求是不会带上 cookie 的,如果想要带的话需要设置withCredentials
为true
,默认false
。method
当上传的时候所使用的是方式,可选multipart
、octet
,默认multipart
testMethod
测试的时候使用的 HTTP 方法,可以是字符串或者函数,如果是函数的话,则会传入Uploader.File
实例、当前块Uploader.Chunk
,默认GET
。uploadMethod
真正上传的时候使用的 HTTP 方法,可以是字符串或者函数,如果是函数的话,则会传入Uploader.File
实例、当前块Uploader.Chunk
,默认POST
。allowDuplicateUploads
如果说一个文件已经上传过了是否还允许再次上传。默认的话如果已经上传了,除非你移除了否则是不会再次重新上传的,所以也就是默认值为false
。prioritizeFirstAndLastChunk
对于文件而言是否高优先级发送第一个和最后一个块。一般用来发送到服务端,然后判断是否是合法文件;例如图片或者视频的 meta 数据一般放在文件第一部分,这样可以根据第一个块就能知道是否支持;默认false
。testChunks
是否测试每个块是否在服务端已经上传了,主要用来实现秒传、跨浏览器上传等,默认true
。preprocess
可选的函数,每个块在测试以及上传前会被调用,参数就是当前上传块实例Uploader.Chunk
,注意在这个函数中你需要调用当前上传块实例的preprocessFinished
方法,默认null
。initFileFn
可选函数用于初始化文件对象,传入的参数就是Uploader.File
实例。readFileFn
可选的函数用于原始文件的读取操作,传入的参数就是Uploader.File
实例、文件类型、开始字节位置 startByte,结束字节位置 endByte、以及当前块Uploader.Chunk
实例。并且当完成后应该调用当前块实例的readFinished
方法,且带参数-已读取的 bytes。checkChunkUploadedByResponse
可选的函数用于根据 XHR 响应内容检测每个块是否上传成功了,传入的参数是:Uploader.Chunk
实例以及请求响应信息。这样就没必要上传(测试)所有的块了,具体细节原因参考generateUniqueIdentifier
可覆盖默认的生成文件唯一标示的函数,默认null
。maxChunkRetries
最大自动失败重试上传次数,值可以是任意正整数,如果是undefined
则代表无限次,默认0
。chunkRetryInterval
重试间隔,值可以是任意正整数,如果是null
则代表立即重试,默认null
。progressCallbacksInterval
进度回调间隔,默认是500
。speedSmoothingFactor
主要用于计算平均速度,值就是从 0 到 1,如果是 1 那么上传的平均速度就等于当前上传速度,如果说长时间上传的话,建议设置为0.02
,这样剩余时间预估会更精确,这个参数是需要和progressCallbacksInterval
一起调整的,默认是0.1
。successStatuses
认为响应式成功的响应码,默认[200, 201, 202]
。permanentErrors
认为是出错的响应码,默认[404, 415, 500, 501]
。initialPaused
初始文件 paused 状态,默认false
。processResponse
处理请求结果,默认function (response, cb) { cb(null, response) }
。 0.5.2版本后,processResponse
会传入更多参数:(response, cb, Uploader.File, Uploader.Chunk)。processParams
处理请求参数,默认function (params) {return params}
,一般用于修改参数名字或者删除参数。0.5.2版本后,processParams
会有更多参数:(params, Uploader.File, Uploader.Chunk, isTest)。
属性
.support
当前浏览器是否支持 File API 来上传。.supportDirectory
当前浏览器是否支持文件夹上传。.opts
实例的配置项对象。.files
由Uploader.File
文件对象组成的数组,纯文件列表。.fileList
由Uploader.File
文件、文件夹对象组成的数组,文件和文件夹共存。
实例引用
const uploaderRef = ref(null)
uploaderRef.value.pause() //暂停
uploaderRef.value.bootstrap() //重新上传
...
方法
.assignBrowse(domNodes, isDirectory, singleFile, attributes)
指定 DOM 元素可以选择上传。domNodes
DOM 元素isDirectory
如果传入的是true
则代表是要选择文件夹上传的,你可以通过判断supportDirectory
来决定是否设置singleFile
是否只能选择单个文件attributes
传入的其他属性值,例如你可以传入accept
属性的值为image/*
,这样就意味着点选的时候只能选择图片。全部属性列表:https://www.w3.org/wiki/HTML/Elements/input/file
Note: 避免使用
a
或者button
标签作为选择文件按钮。.assignDrop(domNodes)
指定 DOM 元素作为拖拽上传目标。.unAssignDrop(domNodes)
取消指定的 DOM 元素作为拖拽上传目标。.on(event, callback)
监听事件。.off([event, [callback]])
:.off(event)
移除指定事件的所有事件回调.off(event, callback)
移除指定事件的指定回调。callback
是一个函数
.upload()
开始或者继续上传。.pause()
暂停上传。.resume()
继续上传。.cancel()
取消所有上传文件,文件会被移除掉。.progress()
返回一个0-1的浮点数,当前上传进度。.isUploading()
返回一个布尔值标示是否还有文件正在上传中。.addFile(file)
添加一个原生的文件对象到上传列表中。.removeFile(file)
从上传列表中移除一个指定的Uploader.File
实例对象。.getFromUniqueIdentifier(uniqueIdentifier)
根据唯一标识找到Uploader.File
实例。.getSize()
上传文件的总大小。.sizeUploaded()
所有已经成功上传文件大小。.timeRemaining()
剩余时间,单位秒;这个是基于平均上传速度计算出来的,如果说上传速度为 0,那么这个值就是Number.POSITIVE_INFINITY
。
事件
.change(event)
input 的 change 事件。.dragover(event)
拖拽区域的 dragover 事件。.dragenter(event)
拖拽区域的 dragenter 事件。.dragleave(event)
拖拽区域的 dragleave 事件。.fileSuccess(rootFile, file, message, chunk)
一个文件上传成功事件,第一个参数rootFile
就是成功上传的文件所属的根Uploader.File
对象,它应该包含或者等于成功上传文件;第二个参数file
就是当前成功的Uploader.File
对象本身;第三个参数就是message
就是服务端响应内容,永远都是字符串;第四个参数chunk
就是Uploader.Chunk
实例,它就是该文件的最后一个块实例,如果你想得到请求响应码的话,chunk.xhr.status
就是。.fileComplete(rootFile)
一个根文件(文件夹)成功上传完成。.fileProgress(rootFile, file, chunk)
一个文件在上传中。.fileAdded(file, event)
这个事件一般用作文件校验,如果说返回了false
,那么这个文件就会被忽略,不会添加到文件上传列表中。.filesAdded(files, fileList, event)
和 fileAdded 一样,但是一般用作多个文件的校验。.filesSubmitted(files, fileList, event)
和 filesAdded 类似,但是是文件已经加入到上传列表中,一般用来开始整个的上传。.fileRemoved(file)
一个文件(文件夹)被移除。.fileRetry(rootFile, file, chunk)
文件重试上传事件。.fileError(rootFile, file, message, chunk)
上传过程中出错了。.uploadStart()
已经开始上传了。.complete()
上传完毕。.catchAll(event, ...)
所有的事件。
Uploader.File
属性
.uploader
对Uploader
实例的引用。.name
文件(夹)名字。.averageSpeed
平均速度,单位字节每秒。.currentSpeed
当前速度,单位字节每秒。.paused
文件是否是暂停的。.error
文件上传是否出错了。.isFolder
是否是文件夹。
如果不是文件夹的话,那么还会有如下属性:
.file
原生 HTML5File
对象。.relativePath
文件相对路径。.size
文件大小,单位字节。.uniqueIdentifier
文件唯一标示。.chunks
由Uploader.Chunk
实例组成数组,分成的块集合,一般场景下并不需要关心它。
方法
.getRoot()
得到当前文件所属的根文件,这个根文件就是包含在uploader.fileList
中的..progress()
返回一个 0 到 1 的数字,代表当前上传进度。.pause()
暂停上传文件。.resume()
继续上传文件。.cancel()
取消上传且从文件列表中移除。.retry()
重新上传文件。.bootstrap()
重新初始化Uploader.File
对象的状态,包括重新分块,重新创建新的 XMLHttpRequest 实例。.isUploading()
文件是否仍在上传中。.isComplete()
文件是否已经上传完成。.sizeUploaded()
已经上传大小。.timeRemaining()
剩余时间,基于平均速度的,如果说平均速度为 0,那么值就是Number.POSITIVE_INFINITY
。.getExtension()
得到小写的后缀。.getType()
得到文件类型。