Skip to content

Latest commit

 

History

History
50 lines (37 loc) · 1.79 KB

README.md

File metadata and controls

50 lines (37 loc) · 1.79 KB

Screw-FileReader

For those who don't like the FileReader

npm version

npm install screw-filereader

A promisified Blob reader and streamer was proposed. But not as a external API like FileReader... Nooo - this is prototyped to Blob/File directly!

This makes it easier to read stuff from Blob's and File's

Here is an example

// require('screw-filereader')
// import screw-filereader

arrayBuffer = await blob.arrayBuffer() // awaits a promise
text = await blob.text() // awaits a promise
stream = blob.stream() // returns a web ReadableStream

// Just bonuses
// ------------
dataUrl = await blob.dataUrl() // awaits a promise
json = await blob.json() // awaits a promise (rejects if fail to parse)
img = await blob.image([preventRevoke=false]) // awaits a new Image object (rejects if fail to load)

// .binaryString() has been avoided
// - Binaries just don't work well with strings face it.
//   Send the blob with ajax instead or use ArrayBuffer if you want to work with the data
//
// Until someone gives me a good reason why I should add them

// returns a blob url (same as [webkit]URL.createObjectURL(blob))
// can also return null if it's not possible like on chrome for iOS...
url = blob.url() || await blob.dataUrl() // this is what blob.image() dose behind the scene...

blob.image() will read the Exif rotation in jpeg images and rotate it accordingly

If streams are not implmented i can suggest web-streams-polyfill then you get all the benefits of pipes as well ✌️