readerjs
v0.0.3
Published
A tiny unified data reader interface for AJAX, local and File API access.
Downloads
2
Readme
Reader.js
Reader.js is a tiny interface to unify three primary methods of reading data with JavaScript: AJAX requests, local disk access (NodeJS) and the HTML5 File API.
Example
var rd = new Reader(Reader.OPEN_FILE);
rd.open(file, function() {
// file has now been opened and is ready for reading
rd.read(1024, function(err, data) {
// data is now an ArrayBuffer
});
});
Here, data
will be an ArrayBuffer
containing the first 1024 bytes from the specified file (which is a File
instance).
The following types exist:
Reader.OPEN_FILE
Treat the specified object as aFile
instance (HTML5 File API)Reader.OPEN_URI
Read the given URI by HTTP requestReader.OPEN_LOCAL
Read the given path locally, works only in NodeJS
The default is Reader.OPEN_URI
.
Methods
open(file, callback)
Open the specified file and call the callback on completion/readyclose()
Close the handle and clean upread(length, position, callback)
Readlength
bytes from offsetposition
and callcallback
with the resulting ArrayBuffer. Ifposition
is a function, it will be assumed to be the callback.
Notes
- You should call
Reader.close()
when finished with the instance to avoid leftover handles (primarily in Node)
License
MIT