Skip to content
Navigation

useDownload

提供文件下载功能和下载进度等相关数据。

progress

下载进度(必须配合 download 方法一起用)。

  • Supported Platforms:
Browser
Electron
App
Server
Scriptlet
  • Type Declarations:
ts
/**
 * 本身是一个 Vue Ref 变量
 */
import('vue').Ref<number>
  • Example:
ts
import { watch } from 'vue'
import { useDownload } from '@lunarxyz/core'

// 必须配合 download 方法一起用
const { progress, download } = useDownload()

// 需要执行下载才能触发进度变化
download({
  url: 'https://example.com/example.apk',
  fileName: 'Example.apk',
})

// 可以监听进度条的变化
watch(progress, (val) => {
  console.log(`当前下载进度:${val}%`)
})

download

文件下载(浏览器需要注意跨域问题)。

  • Supported Platforms:
Browser
Electron
App
Server
Scriptlet
  • Type Declarations:
ts
/**
 * 下载
 */
declare function download(options: DownloadOptions): Promise<boolean>

/**
 * 下载选项
 */
interface DownloadOptions {
  /**
   * 用来下载的文件 URL
   */
  url: string

  /**
   * 保存的文件名(必须包含扩展名)
   */
  fileName: string
}
  • Example:
ts
import { useDownload } from '@lunarxyz/core'

const { download } = useDownload()
download({
  url: 'https://example.com/example.apk',
  fileName: 'Example.apk',
})

Released under the MIT License.