saveAs

Namespaces

• saveAs

Functions

saveAs()

saveAs(data, options)

saveAs(data, options?): Promise<void>

FileSaver 现代版，支持通过 fetcher 获取文件流

Parameters

Parameter	Type	Description
data	SaveAsData	文件下载地址或 Blob 数据
options?	SaveAsOptions	配置项

Returns

Promise<void>

Example

// 默认配置 fetcher
saveAs.defaults.fetcher = (url, options) => {
  const res = fetch(url, { method: 'GET' })
  const filename = parseContentDisposition(res.headers.get('Content-Disposition')).filename
  // 如果附件存在文件名，则设置下载文件名为附件名称
  if (filename) options.filename = filename
  // 返回 Blob 数据
  return res.blob()
}

// 调用接口下载文件
saveAs('/api/example')

// 使用原 FileSaver.saveAs
saveAs('http://example.com/example.img', { filename: '测试.img', fetcher: undefined })

saveAs(data, filename, options)

saveAs(data, filename?, options?): Promise<void>

FileSaver 现代版，支持通过 fetcher 获取文件流

Parameters

Parameter	Type	Description
data	SaveAsData	文件下载地址或 Blob 数据
filename?	string	文件名
options?	SaveAsOptions	配置项

Returns

Promise<void>

Example

// 默认配置 fetcher
saveAs.defaults.fetcher = (url, options) => {
  const res = fetch(url, { method: 'GET' })
  const filename = parseContentDisposition(res.headers.get('Content-Disposition')).filename
  // 如果附件存在文件名，则设置下载文件名为附件名称
  if (filename) options.filename = filename
  // 返回 Blob 数据
  return res.blob()
}

// 调用接口下载文件
saveAs('/api/example')

// 使用原 FileSaver.saveAs
saveAs('http://example.com/example.img', '测试.img', { fetcher: undefined })

Interfaces

SaveAsOptions

Properties

Property	Type	Description
fetcher?	(this, ...arguments_) => Promise<unknown>	-
filename?	string	下载文件名称