参数配置

action

下载文件服务端接口地址

类型 string

默认值 ''

Mock https://sharding-download-server.vercel.app/api/file/download

IMPORTANT

当customRequest配置了值时，action不会校验必填

data

用户自定义接口参数

类型 Record<string, any>

默认值 {}

headers

用户自定义headers

类型 Record<string, string>

默认值 { 'content-type': 'application/json;charset=UTF-8' }

isPart

是否分片下载, 为false时不会进行分片请求和合并操作

类型 boolean

默认值 true

chunkSize

文件分片大小，单位是bit

类型 number

默认值 1024 * 1024 * 2

WARNING

chunkSize过小会导致分片过多，建立http请求过多导致下载慢，用户根据自己的情况可自定义大小

threads

单个文件并发请求数量

类型 number

默认值 6

maxRetries

文件中某个分片请求失败时的重试次数

类型 number

默认值 3

NOTE

设置的值需要大于0，小于等于0时不会进行重试

retryInterval

文件中某个分片请求失败时的重试间隔

类型 number

默认值 500

NOTE

maxRetries设置值有效时生效

storageVersion

DB的versiion

类型 number

默认值 1

storageName

DB的name

类型 string

默认值 file_chunks_db

customRequest

自定义请求, 函数需要返回一个abort方法来取消当前请求

类型 null | Request, Request类型

默认值 null

示例

const customRequest = (options: RequestOptions) => {
  const CancelToken = axios.CancelToken
  const source = CancelToken.source()
  const { data = {}, headers = {}, onProgress = noop, onSuccess = noop, onFail = noop } = options

  download(data, {
    headers,
    cancelToken: source.token,
    onDownloadProgress: function (progressEvent) {
      onProgress(progressEvent)
    },
  })
    .then((response) => {
      onSuccess(response)
    })
    .catch((e) => {
      console.log('error', e)
      onFail(e)
    })

  return {
    abort() {
      source.cancel('Operation canceled by the user.')
    },
  }
}

requestSucceed

判断接口成功的方法

类型 (response: RequestResponse) => boolean, RequestResponse类型

默认值

const requestSucceed = (response: RequestResponse) => {
  const body = await getBody(response)
  if (body.code && body.code !== '00000') {
    return false
  }
  return true
}

示例

 const requestSucceed = (response) => {
    const data = await getBody(response: RequestResponse) // 解析返回的二进制结果
    if (isBlob(data)) {
      return true
    } else {
      if(data.code !== '00000') {
        ElMessage.error(data.message || 'Error')
        return false
      } else {
        return true
      }
    }
  }