在前端开发中,我们常常需要处理文件上传、文件读取等操作。filereader-stream
是一个很好用的 npm 包,可以帮助我们轻松地读取本地文件,并将其转换为流的形式,方便我们进一步的处理。
安装
使用 npm 安装 filereader-stream
:
npm install filereader-stream --save
基本用法
-- -------------------- ---- ------- ------ ---------------- ---- -------------------- ----- ------ - --- ----------------------- ----------------- ------- -- - -- ---- ----- --- ---------------- -- -- - -- ---------- --- ------------------ ----- -- - -- --------- ---展开代码
API 说明
new FileReaderStream(file, options)
创建一个新的 FileReaderStream
实例。
参数 | 类型 | 说明 |
---|---|---|
file | File /Blob |
要读取的文件对象 |
options | object |
读取选项配置参数,可选。 |
可选的配置参数:
参数 | 类型 | 默认值 | 说明 |
---|---|---|---|
start | Number |
0 | 文件读入的起点位置 |
end | Number |
文件大小 | 文件读入的终点位置 |
bufferLength | Number |
64 * 1024 | 每次读取的缓存块大小 |
FileReaderStream#pause()
暂停读取。
FileReaderStream#resume()
恢复读取。
FileReaderStream#abort()
终止读取。
事件
事件 | 说明 |
---|---|
'data' |
文件块读取成功时触发 |
'end' |
文件读取完成时触发 |
'error' |
出现错误时触发 |
事件数据:
'data'
事件:每个 chunk 的数据'end'
事件:无数据'error'
事件:错误对象。
示例
下面是一个完整的示例,读取本地文件并在控制台输出文件内容。
-- -------------------- ---- ------- ------ ---------------- ---- -------------------- ----- --------- - -------------------------------- ------------------------------------ --- -- - ----- ---- - ------------------ ----- ------ - --- ----------------------- ----------------- ------- -- - ------------------------------------- --- ------------------ ----- -- - --------------------------- --- ---------------- -- -- - ---------------------- --- ---展开代码
学习和指导意义
filereader-stream
为前端开发者提供了一个非常方便的文件读取工具,可以在上传文件,处理 CSV 数据等场景下使用。掌握 filereader-stream
的使用,可以提高文件读取的效率,减少上传文件的时间。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/113110