Promisify File Reader



Usage

``html

`

`html

`

Files

`text
dist/
├─ index.cjs ( CommonJS )
├─ index.js ( UMD )
├─ index.min.js ( UMD, compressed )
├─ index.mjs ( ES Module )
└─ index.min.mjs ( ES Module, compressed )
`

API

$3

supported all FileReader methods:

- readAsArrayBuffer
- readAsBinaryString
- readAsDataURL
- readAsText

> FileReader#readAsBinaryString is not available in some browser, like IE 10
>
> we use arrayBuffer to binaryString to support this method

example:

`js
const fileReader = new PromisifyFileReader()
const result = await fileReader.readAsArrayBuffer(file)
`

$3

in fact new PromisifyFileReader() is not really required, all methods can use as static

- readAsArrayBuffer
- readAsBinaryString
- readAsDataURL
- readAsText

example:

`js
const result = await PromisifyFileReader.readAsArrayBuffer(file)
`

$3

you can also strip the readAs prefix

- arrayBuffer
- binaryString
- dataURL
- text

Notice: shortcuts are NOT available in prototype

example:

`js
const result = await PromisifyFileReader.arrayBuffer(file)
// => same as readAsArrayBuffer
`

ES Module

the ES Module build exports

`js
{
// default
PromisifyFileReader as default,

// named
arrayBuffer,
binaryString,
dataURL,
text,
readAsArrayBuffer,
readAsBinaryString,
readAsDataURL,
readAsText,
}
`

import example:

`js
// import default
import PromisifyFileReader from 'promisify-file-reader'

// import named
import {
arrayBuffer,
// ...
} from 'promisify-file-reader'

// import both
import PromisifyFileReader, {
arrayBuffer,
// ...
} from 'promisify-file-reader'
``

Related

- promisify-file