FileReader接口文档

2020-05-31  本文已影响0人  艾瑞克曾

原文地址 https://developer.mozilla.org/zh-CN/docs/Web/API/FileReader

**FileReader** 对象允许 Web 应用程序异步读取存储在用户计算机上的文件(或原始数据缓冲区)的内容,使用 FileBlob 对象指定要读取的文件或数据。

其中 File 对象可以是来自用户在一个 <input>元素上选择文件后返回的 FileList对象, 也可以来自拖放操作生成的 DataTransfer对象, 还可以是来自在一个 HTMLCanvasElement上执行mozGetAsFile()方法后返回结果。

重要提示: FileReader 仅用于以安全的方式从用户(远程)系统读取文件内容 它不能用于从文件系统中按路径名简单地读取文件。 要在 JavaScript 中按路径名读取文件,应使用标准 Ajax 解决方案进行服务器端文件读取,如果读取跨域,则使用 CORS 权限。

Note: 此特性在 Web Worker 中可用。

构造函数

FileReader()

返回一个新构造的FileReader

有关详细信息和示例,请参阅如何在 web 应用程序中使用文件

属性

FileReader.error 只读

一个 DOMException,表示在读取文件时发生的错误 。

FileReader.readyState 只读

表示FileReader状态的数字。取值如下:

FileReader.result 只读

文件的内容。该属性仅在读取操作完成后才有效,数据的格式取决于使用哪个方法来启动读取操作。

事件处理

FileReader.onabort

处理 [abort](/zh-CN/docs/Web/Reference/Events/abort "/zh-CN/docs/Web/Reference/Events/abort")事件。该事件在读取操作被中断时触发。

FileReader.onerror

处理 [error](/zh-CN/docs/Web/Reference/Events/error "/zh-CN/docs/Web/Reference/Events/error")事件。该事件在读取操作发生错误时触发。

FileReader.onload

处理 [load](/zh-CN/docs/Web/Reference/Events/load "/zh-CN/docs/Web/Reference/Events/load")事件。该事件在读取操作完成时触发。

FileReader.onloadstart

处理 [loadstart](/zh-CN/docs/Web/Reference/Events/loadstart "/zh-CN/docs/Web/Reference/Events/loadstart")事件。该事件在读取操作开始时触发。

FileReader.onloadend

处理 [loadend](/zh-CN/docs/Web/Reference/Events/loadend "/zh-CN/docs/Web/Reference/Events/loadend")事件。该事件在读取操作结束时(要么成功,要么失败)触发。

FileReader.onprogress

处理 [progress](/zh-CN/docs/Web/Reference/Events/progress "/zh-CN/docs/Web/Reference/Events/progress")事件。该事件在读取 Blob时触发。

因为 FileReader 继承自 EventTarget,所以所有这些事件也可以通过 addEventListener方法使用。

方法

FileReader.abort()

中止读取操作。在返回时,readyState属性为DONE

FileReader.readAsArrayBuffer()

开始读取指定的 Blob中的内容, 一旦完成, result 属性中保存的将是被读取文件的 ArrayBuffer 数据对象.

FileReader.readAsBinaryString()

开始读取指定的 Blob中的内容。一旦完成,result属性中将包含所读取文件的原始二进制数据。

FileReader.readAsDataURL()

开始读取指定的 Blob中的内容。一旦完成,result属性中将包含一个data: URL 格式的 Base64 字符串以表示所读取文件的内容。

FileReader.readAsText()

开始读取指定的 Blob中的内容。一旦完成,result属性中将包含一个字符串以表示所读取的文件内容。

规范

Specification Status Comment
[File API
FileReader](https://w3c.github.io/FileAPI/#dfn-filereader) Working Draft Initial definition

浏览器兼容

We're converting our compatibility data into a machine-readable JSON format. This compatibility table still uses the old format, because we haven't yet converted the data it contains. Find out how you can help!

3.6 (1.9.2)[1]

[1] Prior to Gecko 2.0 beta 7 (Firefox 4.0 beta 7), all Blob parameters below were File parameters; this has since been updated to match the specification correctly. Prior to Gecko 13.0 (Firefox 13.0 / Thunderbird 13.0 / SeaMonkey 2.10) the FileReader.error property returned a FileError object. This interface has been removed and FileReader.error is now returning the DOMError object as defined in the latest FileAPI draft.

[2] Opera has partial support in 11.1.

相关链接

上一篇 下一篇

猜你喜欢

热点阅读